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 GtkTypeInfo paned_info =
121 sizeof (GtkPanedClass),
122 (GtkClassInitFunc) gtk_paned_class_init,
123 (GtkObjectInitFunc) gtk_paned_init,
124 /* reserved_1 */ NULL,
125 /* reserved_2 */ NULL,
126 (GtkClassInitFunc) NULL,
129 paned_type = gtk_type_unique (GTK_TYPE_CONTAINER, &paned_info);
135 static guint signals[LAST_SIGNAL] = { 0 };
138 add_tab_bindings (GtkBindingSet *binding_set,
139 GdkModifierType modifiers,
142 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
143 "cycle_handle_focus", 1,
144 G_TYPE_BOOLEAN, reverse);
145 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
146 "cycle_handle_focus", 1,
147 G_TYPE_BOOLEAN, reverse);
151 add_move_binding (GtkBindingSet *binding_set,
153 GdkModifierType mask,
154 GtkScrollType scroll)
156 gtk_binding_entry_add_signal (binding_set, keyval, mask,
158 GTK_TYPE_SCROLL_TYPE, scroll);
162 gtk_paned_class_init (GtkPanedClass *class)
164 GObjectClass *object_class;
165 GtkWidgetClass *widget_class;
166 GtkContainerClass *container_class;
167 GtkPanedClass *paned_class;
168 GtkBindingSet *binding_set;
170 object_class = (GObjectClass *) class;
171 widget_class = (GtkWidgetClass *) class;
172 container_class = (GtkContainerClass *) class;
173 paned_class = (GtkPanedClass *) class;
175 parent_class = gtk_type_class (GTK_TYPE_CONTAINER);
177 object_class->set_property = gtk_paned_set_property;
178 object_class->get_property = gtk_paned_get_property;
180 widget_class->realize = gtk_paned_realize;
181 widget_class->unrealize = gtk_paned_unrealize;
182 widget_class->map = gtk_paned_map;
183 widget_class->unmap = gtk_paned_unmap;
184 widget_class->expose_event = gtk_paned_expose;
185 widget_class->focus = gtk_paned_focus;
186 widget_class->enter_notify_event = gtk_paned_enter;
187 widget_class->leave_notify_event = gtk_paned_leave;
188 widget_class->button_press_event = gtk_paned_button_press;
189 widget_class->button_release_event = gtk_paned_button_release;
190 widget_class->motion_notify_event = gtk_paned_motion;
192 container_class->add = gtk_paned_add;
193 container_class->remove = gtk_paned_remove;
194 container_class->forall = gtk_paned_forall;
195 container_class->child_type = gtk_paned_child_type;
196 container_class->set_focus_child = gtk_paned_set_focus_child;
198 paned_class->cycle_child_focus = gtk_paned_cycle_child_focus;
199 paned_class->toggle_handle_focus = gtk_paned_toggle_handle_focus;
200 paned_class->move_handle = gtk_paned_move_handle;
201 paned_class->cycle_handle_focus = gtk_paned_cycle_handle_focus;
202 paned_class->accept_position = gtk_paned_accept_position;
203 paned_class->cancel_position = gtk_paned_cancel_position;
205 g_object_class_install_property (object_class,
207 g_param_spec_int ("position",
209 _("Position of paned separator in pixels (0 means all the way to the left/top)"),
213 G_PARAM_READABLE | G_PARAM_WRITABLE));
214 g_object_class_install_property (object_class,
216 g_param_spec_boolean ("position_set",
218 _("TRUE if the Position property should be used"),
220 G_PARAM_READABLE | G_PARAM_WRITABLE));
222 gtk_widget_class_install_style_property (widget_class,
223 g_param_spec_int ("handle_size",
225 _("Width of handle"),
231 signals [CYCLE_HANDLE_FOCUS] =
232 g_signal_new ("cycle_child_focus",
233 G_TYPE_FROM_CLASS (object_class),
234 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
235 G_STRUCT_OFFSET (GtkPanedClass, cycle_child_focus),
237 _gtk_marshal_BOOLEAN__BOOLEAN,
241 signals [TOGGLE_HANDLE_FOCUS] =
242 g_signal_new ("toggle_handle_focus",
243 G_TYPE_FROM_CLASS (object_class),
244 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
245 G_STRUCT_OFFSET (GtkPanedClass, toggle_handle_focus),
247 _gtk_marshal_BOOLEAN__VOID,
250 signals[MOVE_HANDLE] =
251 g_signal_new ("move_handle",
252 G_TYPE_FROM_CLASS (object_class),
253 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
254 G_STRUCT_OFFSET (GtkPanedClass, move_handle),
256 _gtk_marshal_BOOLEAN__ENUM,
258 GTK_TYPE_SCROLL_TYPE);
260 signals [CYCLE_HANDLE_FOCUS] =
261 g_signal_new ("cycle_handle_focus",
262 G_TYPE_FROM_CLASS (object_class),
263 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
264 G_STRUCT_OFFSET (GtkPanedClass, cycle_handle_focus),
266 _gtk_marshal_BOOLEAN__BOOLEAN,
270 signals [ACCEPT_POSITION] =
271 g_signal_new ("accept_position",
272 G_TYPE_FROM_CLASS (object_class),
273 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
274 G_STRUCT_OFFSET (GtkPanedClass, accept_position),
276 _gtk_marshal_BOOLEAN__VOID,
279 signals [CANCEL_POSITION] =
280 g_signal_new ("cancel_position",
281 G_TYPE_FROM_CLASS (object_class),
282 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
283 G_STRUCT_OFFSET (GtkPanedClass, cancel_position),
285 _gtk_marshal_BOOLEAN__VOID,
288 binding_set = gtk_binding_set_by_class (object_class);
291 gtk_binding_entry_add_signal (binding_set,
293 "cycle_child_focus", 1,
294 G_TYPE_BOOLEAN, FALSE);
295 gtk_binding_entry_add_signal (binding_set,
296 GDK_F6, GDK_SHIFT_MASK,
297 "cycle_child_focus", 1,
298 G_TYPE_BOOLEAN, TRUE);
301 gtk_binding_entry_add_signal (binding_set,
303 "toggle_handle_focus", 0);
305 add_tab_bindings (binding_set, 0, GTK_DIR_TAB_FORWARD);
306 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
307 add_tab_bindings (binding_set, GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
308 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
310 /* accept and cancel positions */
311 gtk_binding_entry_add_signal (binding_set,
313 "cancel_position", 0);
315 gtk_binding_entry_add_signal (binding_set,
317 "accept_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);
329 add_move_binding (binding_set, GDK_Left, 0, GTK_SCROLL_STEP_LEFT);
330 add_move_binding (binding_set, GDK_KP_Left, 0, GTK_SCROLL_STEP_LEFT);
331 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
332 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
334 add_move_binding (binding_set, GDK_Right, 0, GTK_SCROLL_STEP_RIGHT);
335 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
336 add_move_binding (binding_set, GDK_KP_Right, 0, GTK_SCROLL_STEP_RIGHT);
337 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
339 add_move_binding (binding_set, GDK_Up, 0, GTK_SCROLL_STEP_UP);
340 add_move_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
341 add_move_binding (binding_set, GDK_KP_Up, 0, GTK_SCROLL_STEP_UP);
342 add_move_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
343 add_move_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_UP);
344 add_move_binding (binding_set, GDK_KP_Page_Up, 0, GTK_SCROLL_PAGE_UP);
346 add_move_binding (binding_set, GDK_Down, 0, GTK_SCROLL_STEP_DOWN);
347 add_move_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
348 add_move_binding (binding_set, GDK_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
349 add_move_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
350 add_move_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
351 add_move_binding (binding_set, GDK_KP_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
353 add_move_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START);
354 add_move_binding (binding_set, GDK_KP_Home, 0, GTK_SCROLL_START);
355 add_move_binding (binding_set, GDK_End, 0, GTK_SCROLL_END);
356 add_move_binding (binding_set, GDK_KP_End, 0, GTK_SCROLL_END);
360 gtk_paned_child_type (GtkContainer *container)
362 if (!GTK_PANED (container)->child1 || !GTK_PANED (container)->child2)
363 return GTK_TYPE_WIDGET;
365 return GTK_TYPE_NONE;
369 gtk_paned_init (GtkPaned *paned)
371 GTK_WIDGET_SET_FLAGS (paned, GTK_NO_WINDOW | GTK_CAN_FOCUS);
373 paned->child1 = NULL;
374 paned->child2 = NULL;
375 paned->handle = NULL;
376 paned->xor_gc = NULL;
377 paned->cursor_type = GDK_CROSS;
379 paned->handle_pos.width = 5;
380 paned->handle_pos.height = 5;
381 paned->position_set = FALSE;
382 paned->last_allocation = -1;
383 paned->in_drag = FALSE;
385 paned->saved_focus = NULL;
386 paned->last_child1_focus = NULL;
387 paned->last_child2_focus = NULL;
388 paned->in_recursion = FALSE;
389 paned->handle_prelit = FALSE;
390 paned->original_position = -1;
392 paned->handle_pos.x = -1;
393 paned->handle_pos.y = -1;
395 paned->drag_pos = -1;
399 gtk_paned_set_property (GObject *object,
404 GtkPaned *paned = GTK_PANED (object);
409 gtk_paned_set_position (paned, g_value_get_int (value));
411 case PROP_POSITION_SET:
412 paned->position_set = g_value_get_boolean (value);
413 gtk_widget_queue_resize (GTK_WIDGET (paned));
416 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
422 gtk_paned_get_property (GObject *object,
427 GtkPaned *paned = GTK_PANED (object);
432 g_value_set_int (value, paned->child1_size);
434 case PROP_POSITION_SET:
435 g_value_set_boolean (value, paned->position_set);
438 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
444 gtk_paned_realize (GtkWidget *widget)
447 GdkWindowAttr attributes;
448 gint attributes_mask;
450 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
451 paned = GTK_PANED (widget);
453 widget->window = gtk_widget_get_parent_window (widget);
454 gdk_window_ref (widget->window);
456 attributes.window_type = GDK_WINDOW_CHILD;
457 attributes.wclass = GDK_INPUT_ONLY;
458 attributes.x = paned->handle_pos.x;
459 attributes.y = paned->handle_pos.y;
460 attributes.width = paned->handle_pos.width;
461 attributes.height = paned->handle_pos.height;
462 attributes.cursor = gdk_cursor_new (paned->cursor_type);
463 attributes.event_mask = gtk_widget_get_events (widget);
464 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
465 GDK_BUTTON_RELEASE_MASK |
466 GDK_ENTER_NOTIFY_MASK |
467 GDK_LEAVE_NOTIFY_MASK |
468 GDK_POINTER_MOTION_MASK |
469 GDK_POINTER_MOTION_HINT_MASK);
470 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_CURSOR;
472 paned->handle = gdk_window_new (widget->window,
473 &attributes, attributes_mask);
474 gdk_window_set_user_data (paned->handle, paned);
475 gdk_cursor_destroy (attributes.cursor);
477 widget->style = gtk_style_attach (widget->style, widget->window);
479 if (paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
480 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
481 gdk_window_show (paned->handle);
485 gtk_paned_unrealize (GtkWidget *widget)
487 GtkPaned *paned = GTK_PANED (widget);
491 gdk_gc_destroy (paned->xor_gc);
492 paned->xor_gc = NULL;
497 gdk_window_set_user_data (paned->handle, NULL);
498 gdk_window_destroy (paned->handle);
499 paned->handle = NULL;
502 gtk_paned_set_last_child1_focus (paned, NULL);
503 gtk_paned_set_last_child2_focus (paned, NULL);
504 gtk_paned_set_saved_focus (paned, NULL);
506 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
507 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
511 gtk_paned_map (GtkWidget *widget)
513 GtkPaned *paned = GTK_PANED (widget);
515 gdk_window_show (paned->handle);
517 GTK_WIDGET_CLASS (parent_class)->map (widget);
521 gtk_paned_unmap (GtkWidget *widget)
523 GtkPaned *paned = GTK_PANED (widget);
525 gdk_window_hide (paned->handle);
527 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
531 gtk_paned_expose (GtkWidget *widget,
532 GdkEventExpose *event)
534 GtkPaned *paned = GTK_PANED (widget);
536 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
537 paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
538 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
542 region = gdk_region_rectangle (&paned->handle_pos);
543 gdk_region_intersect (region, event->region);
545 if (!gdk_region_empty (region))
550 gdk_region_get_clipbox (region, &clip);
552 if (gtk_widget_is_focus (widget))
553 state = GTK_STATE_SELECTED;
554 else if (paned->handle_prelit)
555 state = GTK_STATE_PRELIGHT;
557 state = GTK_WIDGET_STATE (widget);
559 gtk_paint_handle (widget->style, widget->window,
560 state, GTK_SHADOW_NONE,
561 &clip, widget, "paned",
562 paned->handle_pos.x, paned->handle_pos.y,
563 paned->handle_pos.width, paned->handle_pos.height,
567 gdk_region_destroy (region);
570 /* Chain up to draw children */
571 GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
577 update_drag (GtkPaned *paned)
583 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
584 gtk_widget_get_pointer (GTK_WIDGET (paned), NULL, &pos);
586 gtk_widget_get_pointer (GTK_WIDGET (paned), &pos, NULL);
588 gtk_widget_style_get (GTK_WIDGET (paned), "handle_size", &handle_size, NULL);
590 size = pos - GTK_CONTAINER (paned)->border_width - paned->drag_pos;
591 size = CLAMP (size, paned->min_position, paned->max_position);
593 if (size != paned->child1_size)
594 gtk_paned_set_position (paned, size);
598 gtk_paned_enter (GtkWidget *widget,
599 GdkEventCrossing *event)
601 GtkPaned *paned = GTK_PANED (widget);
607 paned->handle_prelit = TRUE;
608 gtk_widget_queue_draw_area (widget,
611 paned->handle_pos.width,
612 paned->handle_pos.height);
619 gtk_paned_leave (GtkWidget *widget,
620 GdkEventCrossing *event)
622 GtkPaned *paned = GTK_PANED (widget);
628 paned->handle_prelit = FALSE;
629 gtk_widget_queue_draw_area (widget,
632 paned->handle_pos.width,
633 paned->handle_pos.height);
640 gtk_paned_focus (GtkWidget *widget,
641 GtkDirectionType direction)
646 /* This is a hack, but how can this be done without
647 * excessive cut-and-paste from gtkcontainer.c?
650 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
651 retval = (* GTK_WIDGET_CLASS (parent_class)->focus) (widget, direction);
652 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
658 gtk_paned_button_press (GtkWidget *widget,
659 GdkEventButton *event)
661 GtkPaned *paned = GTK_PANED (widget);
663 if (!paned->in_drag &&
664 (event->window == paned->handle) && (event->button == 1))
666 paned->in_drag = TRUE;
668 /* We need a server grab here, not gtk_grab_add(), since
669 * we don't want to pass events on to the widget's children */
670 gdk_pointer_grab (paned->handle, FALSE,
671 GDK_POINTER_MOTION_HINT_MASK
672 | GDK_BUTTON1_MOTION_MASK
673 | GDK_BUTTON_RELEASE_MASK
674 | GDK_ENTER_NOTIFY_MASK
675 | GDK_LEAVE_NOTIFY_MASK,
679 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
680 paned->drag_pos = event->y;
682 paned->drag_pos = event->x;
691 gtk_paned_button_release (GtkWidget *widget,
692 GdkEventButton *event)
694 GtkPaned *paned = GTK_PANED (widget);
696 if (paned->in_drag && (event->button == 1))
698 paned->in_drag = FALSE;
699 paned->drag_pos = -1;
700 paned->position_set = TRUE;
701 gdk_pointer_ungrab (event->time);
710 gtk_paned_motion (GtkWidget *widget,
711 GdkEventMotion *event)
713 GtkPaned *paned = GTK_PANED (widget);
725 gtk_paned_add1 (GtkPaned *paned,
728 gtk_paned_pack1 (paned, widget, FALSE, TRUE);
732 gtk_paned_add2 (GtkPaned *paned,
735 gtk_paned_pack2 (paned, widget, TRUE, TRUE);
739 gtk_paned_pack1 (GtkPaned *paned,
744 g_return_if_fail (GTK_IS_PANED (paned));
745 g_return_if_fail (GTK_IS_WIDGET (child));
749 paned->child1 = child;
750 paned->child1_resize = resize;
751 paned->child1_shrink = shrink;
753 gtk_widget_set_parent (child, GTK_WIDGET (paned));
758 gtk_paned_pack2 (GtkPaned *paned,
763 g_return_if_fail (GTK_IS_PANED (paned));
764 g_return_if_fail (GTK_IS_WIDGET (child));
768 paned->child2 = child;
769 paned->child2_resize = resize;
770 paned->child2_shrink = shrink;
772 gtk_widget_set_parent (child, GTK_WIDGET (paned));
778 gtk_paned_add (GtkContainer *container,
783 g_return_if_fail (GTK_IS_PANED (container));
785 paned = GTK_PANED (container);
788 gtk_paned_add1 (paned, widget);
789 else if (!paned->child2)
790 gtk_paned_add2 (paned, widget);
794 gtk_paned_remove (GtkContainer *container,
798 gboolean was_visible;
800 paned = GTK_PANED (container);
801 was_visible = GTK_WIDGET_VISIBLE (widget);
803 if (paned->child1 == widget)
805 gtk_widget_unparent (widget);
807 paned->child1 = NULL;
809 if (was_visible && GTK_WIDGET_VISIBLE (container))
810 gtk_widget_queue_resize (GTK_WIDGET (container));
812 else if (paned->child2 == widget)
814 gtk_widget_unparent (widget);
816 paned->child2 = NULL;
818 if (was_visible && GTK_WIDGET_VISIBLE (container))
819 gtk_widget_queue_resize (GTK_WIDGET (container));
824 gtk_paned_forall (GtkContainer *container,
825 gboolean include_internals,
826 GtkCallback callback,
827 gpointer callback_data)
831 g_return_if_fail (callback != NULL);
833 paned = GTK_PANED (container);
836 (*callback) (paned->child1, callback_data);
838 (*callback) (paned->child2, callback_data);
842 * gtk_paned_get_position:
843 * @paned: a #GtkPaned widget
845 * Obtains the position of the divider between the two panes.
847 * Return value: position of the divider
850 gtk_paned_get_position (GtkPaned *paned)
852 g_return_val_if_fail (GTK_IS_PANED (paned), 0);
854 return paned->child1_size;
858 * gtk_paned_set_position:
859 * @paned: a #GtkPaned widget
860 * @position: pixel position of divider, a negative value means that the position
863 * Sets the position of the divider between the two panes.
866 gtk_paned_set_position (GtkPaned *paned,
871 g_return_if_fail (GTK_IS_PANED (paned));
873 object = G_OBJECT (paned);
877 /* We don't clamp here - the assumption is that
878 * if the total allocation changes at the same time
879 * as the position, the position set is with reference
880 * to the new total size. If only the position changes,
881 * then clamping will occur in gtk_paned_compute_position()
884 paned->child1_size = position;
885 paned->position_set = TRUE;
889 paned->position_set = FALSE;
892 g_object_freeze_notify (object);
893 g_object_notify (object, "position");
894 g_object_notify (object, "position_set");
895 g_object_thaw_notify (object);
897 gtk_widget_queue_resize (GTK_WIDGET (paned));
901 gtk_paned_compute_position (GtkPaned *paned,
908 g_return_if_fail (GTK_IS_PANED (paned));
910 old_position = paned->child1_size;
912 paned->min_position = paned->child1_shrink ? 0 : child1_req;
914 paned->max_position = allocation;
915 if (!paned->child2_shrink)
916 paned->max_position = MAX (1, paned->max_position - child2_req);
918 if (!paned->position_set)
920 if (paned->child1_resize && !paned->child2_resize)
921 paned->child1_size = MAX (1, allocation - child2_req);
922 else if (!paned->child1_resize && paned->child2_resize)
923 paned->child1_size = child1_req;
924 else if (child1_req + child2_req != 0)
925 paned->child1_size = allocation * ((gdouble)child1_req / (child1_req + child2_req));
927 paned->child1_size = allocation * 0.5;
931 /* If the position was set before the initial allocation.
932 * (paned->last_allocation <= 0) just clamp it and leave it.
934 if (paned->last_allocation > 0)
936 if (paned->child1_resize && !paned->child2_resize)
937 paned->child1_size += allocation - paned->last_allocation;
938 else if (!(!paned->child1_resize && paned->child2_resize))
939 paned->child1_size = allocation * ((gdouble) paned->child1_size / (paned->last_allocation));
943 paned->child1_size = CLAMP (paned->child1_size,
945 paned->max_position);
947 if (paned->child1_size != old_position)
948 g_object_notify (G_OBJECT (paned), "position");
950 paned->last_allocation = allocation;
954 gtk_paned_set_saved_focus (GtkPaned *paned, GtkWidget *widget)
956 if (paned->saved_focus)
957 g_object_remove_weak_pointer (G_OBJECT (paned->saved_focus),
958 (gpointer *)&(paned->saved_focus));
960 paned->saved_focus = widget;
962 if (paned->saved_focus)
963 g_object_add_weak_pointer (G_OBJECT (paned->saved_focus),
964 (gpointer *)&(paned->saved_focus));
968 gtk_paned_set_last_child1_focus (GtkPaned *paned, GtkWidget *widget)
970 if (paned->last_child1_focus)
971 g_object_remove_weak_pointer (G_OBJECT (paned->last_child1_focus),
972 (gpointer *)&(paned->last_child1_focus));
974 paned->last_child1_focus = widget;
976 if (paned->last_child1_focus)
977 g_object_add_weak_pointer (G_OBJECT (paned->last_child1_focus),
978 (gpointer *)&(paned->last_child1_focus));
982 gtk_paned_set_last_child2_focus (GtkPaned *paned, GtkWidget *widget)
984 if (paned->last_child2_focus)
985 g_object_remove_weak_pointer (G_OBJECT (paned->last_child2_focus),
986 (gpointer *)&(paned->last_child2_focus));
988 paned->last_child2_focus = widget;
990 if (paned->last_child2_focus)
991 g_object_add_weak_pointer (G_OBJECT (paned->last_child2_focus),
992 (gpointer *)&(paned->last_child2_focus));
996 paned_get_focus_widget (GtkPaned *paned)
1000 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1001 if (GTK_WIDGET_TOPLEVEL (toplevel))
1002 return GTK_WINDOW (toplevel)->focus_widget;
1008 gtk_paned_set_focus_child (GtkContainer *container,
1009 GtkWidget *focus_child)
1013 g_return_if_fail (GTK_IS_PANED (container));
1015 paned = GTK_PANED (container);
1017 if (focus_child == NULL)
1019 GtkWidget *last_focus;
1022 last_focus = paned_get_focus_widget (paned);
1026 /* If there is one or more paned widgets between us and the
1027 * focus widget, we want the topmost of those as last_focus
1029 for (w = last_focus; w != GTK_WIDGET (paned); w = w->parent)
1030 if (GTK_IS_PANED (w))
1033 if (container->focus_child == paned->child1)
1034 gtk_paned_set_last_child1_focus (paned, last_focus);
1035 else if (container->focus_child == paned->child2)
1036 gtk_paned_set_last_child2_focus (paned, last_focus);
1040 if (parent_class->set_focus_child)
1041 (* parent_class->set_focus_child) (container, focus_child);
1045 gtk_paned_get_cycle_chain (GtkPaned *paned,
1046 GtkDirectionType direction,
1049 GtkContainer *container = GTK_CONTAINER (paned);
1050 GtkWidget *ancestor = NULL;
1051 GList *temp_list = NULL;
1054 if (paned->in_recursion)
1057 g_assert (widgets != NULL);
1059 if (paned->last_child1_focus &&
1060 !gtk_widget_is_ancestor (paned->last_child1_focus, GTK_WIDGET (paned)))
1062 gtk_paned_set_last_child1_focus (paned, NULL);
1065 if (paned->last_child2_focus &&
1066 !gtk_widget_is_ancestor (paned->last_child2_focus, GTK_WIDGET (paned)))
1068 gtk_paned_set_last_child2_focus (paned, NULL);
1071 if (GTK_WIDGET (paned)->parent)
1072 ancestor = gtk_widget_get_ancestor (GTK_WIDGET (paned)->parent, GTK_TYPE_PANED);
1074 /* The idea here is that temp_list is a list of widgets we want to cycle
1075 * to. The list is prioritized so that the first element is our first
1076 * choice, the next our second, and so on.
1078 * We can't just use g_list_reverse(), because we want to try
1079 * paned->last_child?_focus before paned->child?, both when we
1080 * are going forward and backward.
1082 if (direction == GTK_DIR_TAB_FORWARD)
1084 if (container->focus_child == paned->child1)
1086 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1087 temp_list = g_list_append (temp_list, paned->child2);
1088 temp_list = g_list_append (temp_list, ancestor);
1090 else if (container->focus_child == paned->child2)
1092 temp_list = g_list_append (temp_list, ancestor);
1093 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1094 temp_list = g_list_append (temp_list, paned->child1);
1098 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1099 temp_list = g_list_append (temp_list, paned->child1);
1100 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1101 temp_list = g_list_append (temp_list, paned->child2);
1102 temp_list = g_list_append (temp_list, ancestor);
1107 if (container->focus_child == paned->child1)
1109 temp_list = g_list_append (temp_list, ancestor);
1110 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1111 temp_list = g_list_append (temp_list, paned->child2);
1113 else if (container->focus_child == paned->child2)
1115 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1116 temp_list = g_list_append (temp_list, paned->child1);
1117 temp_list = g_list_append (temp_list, ancestor);
1121 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1122 temp_list = g_list_append (temp_list, paned->child2);
1123 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1124 temp_list = g_list_append (temp_list, paned->child1);
1125 temp_list = g_list_append (temp_list, ancestor);
1129 /* Walk through the list and expand all the paned widgets. */
1130 for (list = temp_list; list != NULL; list = list->next)
1132 GtkWidget *widget = list->data;
1136 if (GTK_IS_PANED (widget))
1138 paned->in_recursion = TRUE;
1139 gtk_paned_get_cycle_chain (GTK_PANED (widget), direction, widgets);
1140 paned->in_recursion = FALSE;
1144 *widgets = g_list_append (*widgets, widget);
1149 g_list_free (temp_list);
1153 gtk_paned_cycle_child_focus (GtkPaned *paned,
1156 GList *cycle_chain = NULL;
1159 GtkDirectionType direction = reversed? GTK_DIR_TAB_BACKWARD : GTK_DIR_TAB_FORWARD;
1161 /* ignore f6 if the handle is focused */
1162 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1165 /* we can't just let the event propagate up the hierarchy,
1166 * because the paned will want to cycle focus _unless_ an
1167 * ancestor paned handles the event
1169 gtk_paned_get_cycle_chain (paned, direction, &cycle_chain);
1171 for (list = cycle_chain; list != NULL; list = list->next)
1172 if (gtk_widget_child_focus (GTK_WIDGET (list->data), direction))
1175 g_list_free (cycle_chain);
1181 get_child_panes (GtkWidget *widget,
1184 if (GTK_IS_PANED (widget))
1186 GtkPaned *paned = GTK_PANED (widget);
1188 get_child_panes (paned->child1, panes);
1189 *panes = g_list_prepend (*panes, widget);
1190 get_child_panes (paned->child2, panes);
1192 else if (GTK_IS_CONTAINER (widget))
1194 gtk_container_foreach (GTK_CONTAINER (widget),
1195 (GtkCallback)get_child_panes, panes);
1200 get_all_panes (GtkPaned *paned)
1202 GtkPaned *topmost = NULL;
1203 GList *result = NULL;
1206 for (w = GTK_WIDGET (paned); w != NULL; w = w->parent)
1208 if (GTK_IS_PANED (w))
1209 topmost = GTK_PANED (w);
1214 get_child_panes (GTK_WIDGET (topmost), &result);
1216 return g_list_reverse (result);
1220 gtk_paned_find_neighbours (GtkPaned *paned,
1224 GList *all_panes = get_all_panes (paned);
1227 g_assert (all_panes);
1229 this_link = g_list_find (all_panes, paned);
1231 g_assert (this_link);
1233 if (this_link->next)
1234 *next = this_link->next->data;
1236 *next = all_panes->data;
1238 if (this_link->prev)
1239 *prev = this_link->prev->data;
1241 *prev = g_list_last (all_panes)->data;
1249 g_list_free (all_panes);
1253 gtk_paned_move_handle (GtkPaned *paned,
1254 GtkScrollType scroll)
1256 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1262 SINGLE_STEP_SIZE = 1,
1266 old_position = gtk_paned_get_position (paned);
1270 case GTK_SCROLL_STEP_LEFT:
1271 case GTK_SCROLL_STEP_UP:
1272 case GTK_SCROLL_STEP_BACKWARD:
1273 new_position = old_position - SINGLE_STEP_SIZE;
1276 case GTK_SCROLL_STEP_RIGHT:
1277 case GTK_SCROLL_STEP_DOWN:
1278 case GTK_SCROLL_STEP_FORWARD:
1279 new_position = old_position + SINGLE_STEP_SIZE;
1282 case GTK_SCROLL_PAGE_LEFT:
1283 case GTK_SCROLL_PAGE_UP:
1284 case GTK_SCROLL_PAGE_BACKWARD:
1285 new_position = old_position - PAGE_STEP_SIZE;
1288 case GTK_SCROLL_PAGE_RIGHT:
1289 case GTK_SCROLL_PAGE_DOWN:
1290 case GTK_SCROLL_PAGE_FORWARD:
1291 new_position = old_position + PAGE_STEP_SIZE;
1294 case GTK_SCROLL_START:
1295 new_position = paned->min_position;
1298 case GTK_SCROLL_END:
1299 new_position = paned->max_position;
1303 new_position = old_position;
1307 new_position = CLAMP (new_position, paned->min_position, paned->max_position);
1309 if (old_position != new_position)
1310 gtk_paned_set_position (paned, new_position);
1319 gtk_paned_restore_focus (GtkPaned *paned)
1321 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1323 if (paned->saved_focus && GTK_WIDGET_SENSITIVE (paned->saved_focus))
1325 gtk_widget_grab_focus (paned->saved_focus);
1329 /* the saved focus is somehow not available for focusing,
1331 * 1) tabbing into the paned widget
1332 * if that didn't work,
1333 * 2) unset focus for the window if there is one
1336 if (!gtk_widget_child_focus (GTK_WIDGET (paned), GTK_DIR_TAB_FORWARD))
1338 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1340 if (GTK_IS_WINDOW (toplevel))
1341 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1345 gtk_paned_set_saved_focus (paned, NULL);
1350 gtk_paned_accept_position (GtkPaned *paned)
1352 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1354 paned->original_position = -1;
1355 gtk_paned_restore_focus (paned);
1365 gtk_paned_cancel_position (GtkPaned *paned)
1367 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1369 if (paned->original_position != -1)
1371 gtk_paned_set_position (paned, paned->original_position);
1372 paned->original_position = -1;
1375 gtk_paned_restore_focus (paned);
1383 gtk_paned_cycle_handle_focus (GtkPaned *paned,
1386 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1388 GtkPaned *next, *prev;
1389 GtkPaned *focus = NULL;
1391 gtk_paned_find_neighbours (paned, &next, &prev);
1393 if (reversed && prev)
1395 else if (!reversed && next)
1400 gtk_paned_set_saved_focus (focus, paned->saved_focus);
1401 gtk_paned_set_saved_focus (paned, NULL);
1402 gtk_widget_grab_focus (GTK_WIDGET (focus));
1404 if (!gtk_widget_is_focus (GTK_WIDGET (paned)))
1406 paned->original_position = -1;
1407 focus->original_position = gtk_paned_get_position (focus);
1418 gtk_paned_toggle_handle_focus (GtkPaned *paned)
1420 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1422 gtk_paned_accept_position (paned);
1426 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1428 if (GTK_IS_WINDOW (toplevel))
1429 gtk_paned_set_saved_focus (paned, GTK_WINDOW (toplevel)->focus_widget);
1431 gtk_widget_grab_focus (GTK_WIDGET (paned));
1432 paned->original_position = gtk_paned_get_position (paned);