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/.
30 #include "gtkbindings.h"
31 #include "gtksignal.h"
32 #include "gdk/gdkkeysyms.h"
33 #include "gtkwindow.h"
35 #include "gtkmarshalers.h"
36 #include "gtkprivate.h"
63 static void gtk_paned_class_init (GtkPanedClass *klass);
64 static void gtk_paned_init (GtkPaned *paned);
65 static void gtk_paned_set_property (GObject *object,
69 static void gtk_paned_get_property (GObject *object,
73 static void gtk_paned_set_child_property (GtkContainer *container,
78 static void gtk_paned_get_child_property (GtkContainer *container,
83 static void gtk_paned_finalize (GObject *object);
84 static void gtk_paned_realize (GtkWidget *widget);
85 static void gtk_paned_unrealize (GtkWidget *widget);
86 static void gtk_paned_map (GtkWidget *widget);
87 static void gtk_paned_unmap (GtkWidget *widget);
88 static gboolean gtk_paned_expose (GtkWidget *widget,
89 GdkEventExpose *event);
90 static gboolean gtk_paned_enter (GtkWidget *widget,
91 GdkEventCrossing *event);
92 static gboolean gtk_paned_leave (GtkWidget *widget,
93 GdkEventCrossing *event);
94 static gboolean gtk_paned_button_press (GtkWidget *widget,
95 GdkEventButton *event);
96 static gboolean gtk_paned_button_release (GtkWidget *widget,
97 GdkEventButton *event);
98 static gboolean gtk_paned_motion (GtkWidget *widget,
99 GdkEventMotion *event);
100 static gboolean gtk_paned_focus (GtkWidget *widget,
101 GtkDirectionType direction);
102 static void gtk_paned_add (GtkContainer *container,
104 static void gtk_paned_remove (GtkContainer *container,
106 static void gtk_paned_forall (GtkContainer *container,
107 gboolean include_internals,
108 GtkCallback callback,
109 gpointer callback_data);
110 static void gtk_paned_set_focus_child (GtkContainer *container,
112 static void gtk_paned_set_saved_focus (GtkPaned *paned,
114 static void gtk_paned_set_first_paned (GtkPaned *paned,
115 GtkPaned *first_paned);
116 static void gtk_paned_set_last_child1_focus (GtkPaned *paned,
118 static void gtk_paned_set_last_child2_focus (GtkPaned *paned,
120 static gboolean gtk_paned_cycle_child_focus (GtkPaned *paned,
122 static gboolean gtk_paned_cycle_handle_focus (GtkPaned *paned,
124 static gboolean gtk_paned_move_handle (GtkPaned *paned,
125 GtkScrollType scroll);
126 static gboolean gtk_paned_accept_position (GtkPaned *paned);
127 static gboolean gtk_paned_cancel_position (GtkPaned *paned);
128 static gboolean gtk_paned_toggle_handle_focus (GtkPaned *paned);
130 static GType gtk_paned_child_type (GtkContainer *container);
132 static GtkContainerClass *parent_class = NULL;
134 struct _GtkPanedPrivate
136 GtkWidget *saved_focus;
137 GtkPaned *first_paned;
141 gtk_paned_get_type (void)
143 static GType paned_type = 0;
147 static const GTypeInfo paned_info =
149 sizeof (GtkPanedClass),
150 NULL, /* base_init */
151 NULL, /* base_finalize */
152 (GClassInitFunc) gtk_paned_class_init,
153 NULL, /* class_finalize */
154 NULL, /* class_data */
157 (GInstanceInitFunc) gtk_paned_init,
158 NULL, /* value_table */
161 paned_type = g_type_register_static (GTK_TYPE_CONTAINER, "GtkPaned",
162 &paned_info, G_TYPE_FLAG_ABSTRACT);
168 static guint signals[LAST_SIGNAL] = { 0 };
171 add_tab_bindings (GtkBindingSet *binding_set,
172 GdkModifierType modifiers)
174 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
175 "toggle_handle_focus", 0);
176 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
177 "toggle_handle_focus", 0);
181 add_move_binding (GtkBindingSet *binding_set,
183 GdkModifierType mask,
184 GtkScrollType scroll)
186 gtk_binding_entry_add_signal (binding_set, keyval, mask,
188 GTK_TYPE_SCROLL_TYPE, scroll);
192 gtk_paned_class_init (GtkPanedClass *class)
194 GObjectClass *object_class;
195 GtkWidgetClass *widget_class;
196 GtkContainerClass *container_class;
197 GtkPanedClass *paned_class;
198 GtkBindingSet *binding_set;
200 object_class = (GObjectClass *) class;
201 widget_class = (GtkWidgetClass *) class;
202 container_class = (GtkContainerClass *) class;
203 paned_class = (GtkPanedClass *) class;
205 parent_class = g_type_class_peek_parent (class);
207 object_class->set_property = gtk_paned_set_property;
208 object_class->get_property = gtk_paned_get_property;
209 object_class->finalize = gtk_paned_finalize;
211 widget_class->realize = gtk_paned_realize;
212 widget_class->unrealize = gtk_paned_unrealize;
213 widget_class->map = gtk_paned_map;
214 widget_class->unmap = gtk_paned_unmap;
215 widget_class->expose_event = gtk_paned_expose;
216 widget_class->focus = gtk_paned_focus;
217 widget_class->enter_notify_event = gtk_paned_enter;
218 widget_class->leave_notify_event = gtk_paned_leave;
219 widget_class->button_press_event = gtk_paned_button_press;
220 widget_class->button_release_event = gtk_paned_button_release;
221 widget_class->motion_notify_event = gtk_paned_motion;
223 container_class->add = gtk_paned_add;
224 container_class->remove = gtk_paned_remove;
225 container_class->forall = gtk_paned_forall;
226 container_class->child_type = gtk_paned_child_type;
227 container_class->set_focus_child = gtk_paned_set_focus_child;
228 container_class->set_child_property = gtk_paned_set_child_property;
229 container_class->get_child_property = gtk_paned_get_child_property;
231 paned_class->cycle_child_focus = gtk_paned_cycle_child_focus;
232 paned_class->toggle_handle_focus = gtk_paned_toggle_handle_focus;
233 paned_class->move_handle = gtk_paned_move_handle;
234 paned_class->cycle_handle_focus = gtk_paned_cycle_handle_focus;
235 paned_class->accept_position = gtk_paned_accept_position;
236 paned_class->cancel_position = gtk_paned_cancel_position;
238 g_object_class_install_property (object_class,
240 g_param_spec_int ("position",
242 P_("Position of paned separator in pixels (0 means all the way to the left/top)"),
246 GTK_PARAM_READWRITE));
247 g_object_class_install_property (object_class,
249 g_param_spec_boolean ("position-set",
251 P_("TRUE if the Position property should be used"),
253 GTK_PARAM_READWRITE));
255 gtk_widget_class_install_style_property (widget_class,
256 g_param_spec_int ("handle-size",
258 P_("Width of handle"),
262 GTK_PARAM_READABLE));
264 * GtkPaned:min-position:
266 * The smallest possible value for the position property. This property is derived from the
267 * size and shrinkability of the widget's children.
271 g_object_class_install_property (object_class,
273 g_param_spec_int ("min-position",
274 P_("Minimal Position"),
275 P_("Smallest possible value for the \"position\" property"),
279 GTK_PARAM_READABLE));
282 * GtkPaned:max-position:
284 * The largest possible value for the position property. This property is derived from the
285 * size and shrinkability of the widget's children.
289 g_object_class_install_property (object_class,
291 g_param_spec_int ("max-position",
292 P_("Maximal Position"),
293 P_("Largest possible value for the \"position\" property"),
297 GTK_PARAM_READABLE));
302 * The "resize" child property determines whether the child expands and
303 * shrinks along with the paned widget.
307 gtk_container_class_install_child_property (container_class,
309 g_param_spec_boolean ("resize",
311 P_("If TRUE, the child expands and shrinks along with the paned widget"),
313 GTK_PARAM_READWRITE));
318 * The "shrink" child property determines whether the child can be made
319 * smaller than its requisition.
323 gtk_container_class_install_child_property (container_class,
325 g_param_spec_boolean ("shrink",
327 P_("If TRUE, the child can be made smaller than its requisition"),
329 GTK_PARAM_READWRITE));
331 signals [CYCLE_CHILD_FOCUS] =
332 g_signal_new ("cycle_child_focus",
333 G_TYPE_FROM_CLASS (object_class),
334 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
335 G_STRUCT_OFFSET (GtkPanedClass, cycle_child_focus),
337 _gtk_marshal_BOOLEAN__BOOLEAN,
341 signals [TOGGLE_HANDLE_FOCUS] =
342 g_signal_new ("toggle_handle_focus",
343 G_TYPE_FROM_CLASS (object_class),
344 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
345 G_STRUCT_OFFSET (GtkPanedClass, toggle_handle_focus),
347 _gtk_marshal_BOOLEAN__VOID,
350 signals[MOVE_HANDLE] =
351 g_signal_new ("move_handle",
352 G_TYPE_FROM_CLASS (object_class),
353 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
354 G_STRUCT_OFFSET (GtkPanedClass, move_handle),
356 _gtk_marshal_BOOLEAN__ENUM,
358 GTK_TYPE_SCROLL_TYPE);
360 signals [CYCLE_HANDLE_FOCUS] =
361 g_signal_new ("cycle_handle_focus",
362 G_TYPE_FROM_CLASS (object_class),
363 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
364 G_STRUCT_OFFSET (GtkPanedClass, cycle_handle_focus),
366 _gtk_marshal_BOOLEAN__BOOLEAN,
370 signals [ACCEPT_POSITION] =
371 g_signal_new ("accept_position",
372 G_TYPE_FROM_CLASS (object_class),
373 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
374 G_STRUCT_OFFSET (GtkPanedClass, accept_position),
376 _gtk_marshal_BOOLEAN__VOID,
379 signals [CANCEL_POSITION] =
380 g_signal_new ("cancel_position",
381 G_TYPE_FROM_CLASS (object_class),
382 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
383 G_STRUCT_OFFSET (GtkPanedClass, cancel_position),
385 _gtk_marshal_BOOLEAN__VOID,
388 binding_set = gtk_binding_set_by_class (class);
391 gtk_binding_entry_add_signal (binding_set,
393 "cycle_child_focus", 1,
394 G_TYPE_BOOLEAN, FALSE);
395 gtk_binding_entry_add_signal (binding_set,
396 GDK_F6, GDK_SHIFT_MASK,
397 "cycle_child_focus", 1,
398 G_TYPE_BOOLEAN, TRUE);
401 gtk_binding_entry_add_signal (binding_set,
403 "cycle_handle_focus", 1,
404 G_TYPE_BOOLEAN, FALSE);
406 gtk_binding_entry_add_signal (binding_set,
407 GDK_F8, GDK_SHIFT_MASK,
408 "cycle_handle_focus", 1,
409 G_TYPE_BOOLEAN, TRUE);
411 add_tab_bindings (binding_set, 0);
412 add_tab_bindings (binding_set, GDK_CONTROL_MASK);
413 add_tab_bindings (binding_set, GDK_SHIFT_MASK);
414 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK);
416 /* accept and cancel positions */
417 gtk_binding_entry_add_signal (binding_set,
419 "cancel_position", 0);
421 gtk_binding_entry_add_signal (binding_set,
423 "accept_position", 0);
424 gtk_binding_entry_add_signal (binding_set,
426 "accept_position", 0);
427 gtk_binding_entry_add_signal (binding_set,
429 "accept_position", 0);
430 gtk_binding_entry_add_signal (binding_set,
432 "accept_position", 0);
435 add_move_binding (binding_set, GDK_Left, 0, GTK_SCROLL_STEP_LEFT);
436 add_move_binding (binding_set, GDK_KP_Left, 0, GTK_SCROLL_STEP_LEFT);
437 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
438 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
440 add_move_binding (binding_set, GDK_Right, 0, GTK_SCROLL_STEP_RIGHT);
441 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
442 add_move_binding (binding_set, GDK_KP_Right, 0, GTK_SCROLL_STEP_RIGHT);
443 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
445 add_move_binding (binding_set, GDK_Up, 0, GTK_SCROLL_STEP_UP);
446 add_move_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
447 add_move_binding (binding_set, GDK_KP_Up, 0, GTK_SCROLL_STEP_UP);
448 add_move_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
449 add_move_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_UP);
450 add_move_binding (binding_set, GDK_KP_Page_Up, 0, GTK_SCROLL_PAGE_UP);
452 add_move_binding (binding_set, GDK_Down, 0, GTK_SCROLL_STEP_DOWN);
453 add_move_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
454 add_move_binding (binding_set, GDK_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
455 add_move_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
456 add_move_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
457 add_move_binding (binding_set, GDK_KP_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
459 add_move_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START);
460 add_move_binding (binding_set, GDK_KP_Home, 0, GTK_SCROLL_START);
461 add_move_binding (binding_set, GDK_End, 0, GTK_SCROLL_END);
462 add_move_binding (binding_set, GDK_KP_End, 0, GTK_SCROLL_END);
466 gtk_paned_child_type (GtkContainer *container)
468 if (!GTK_PANED (container)->child1 || !GTK_PANED (container)->child2)
469 return GTK_TYPE_WIDGET;
475 gtk_paned_init (GtkPaned *paned)
477 GTK_WIDGET_SET_FLAGS (paned, GTK_NO_WINDOW | GTK_CAN_FOCUS);
479 paned->child1 = NULL;
480 paned->child2 = NULL;
481 paned->handle = NULL;
482 paned->xor_gc = NULL;
483 paned->cursor_type = GDK_CROSS;
485 paned->handle_pos.width = 5;
486 paned->handle_pos.height = 5;
487 paned->position_set = FALSE;
488 paned->last_allocation = -1;
489 paned->in_drag = FALSE;
491 paned->priv = g_new0 (GtkPanedPrivate, 1);
492 paned->last_child1_focus = NULL;
493 paned->last_child2_focus = NULL;
494 paned->in_recursion = FALSE;
495 paned->handle_prelit = FALSE;
496 paned->original_position = -1;
498 paned->handle_pos.x = -1;
499 paned->handle_pos.y = -1;
501 paned->drag_pos = -1;
505 gtk_paned_set_property (GObject *object,
510 GtkPaned *paned = GTK_PANED (object);
515 gtk_paned_set_position (paned, g_value_get_int (value));
517 case PROP_POSITION_SET:
518 paned->position_set = g_value_get_boolean (value);
519 gtk_widget_queue_resize (GTK_WIDGET (paned));
522 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
528 gtk_paned_get_property (GObject *object,
533 GtkPaned *paned = GTK_PANED (object);
538 g_value_set_int (value, paned->child1_size);
540 case PROP_POSITION_SET:
541 g_value_set_boolean (value, paned->position_set);
543 case PROP_MIN_POSITION:
544 g_value_set_int (value, paned->min_position);
546 case PROP_MAX_POSITION:
547 g_value_set_int (value, paned->max_position);
550 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
556 gtk_paned_set_child_property (GtkContainer *container,
562 GtkPaned *paned = GTK_PANED (container);
563 gboolean old_value, new_value;
565 g_assert (child == paned->child1 || child == paned->child2);
567 new_value = g_value_get_boolean (value);
570 case CHILD_PROP_RESIZE:
571 if (child == paned->child1)
573 old_value = paned->child1_resize;
574 paned->child1_resize = new_value;
578 old_value = paned->child2_resize;
579 paned->child2_resize = new_value;
582 case CHILD_PROP_SHRINK:
583 if (child == paned->child1)
585 old_value = paned->child1_shrink;
586 paned->child1_shrink = new_value;
590 old_value = paned->child2_shrink;
591 paned->child2_shrink = new_value;
595 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
596 old_value = -1; /* quiet gcc */
599 if (old_value != new_value)
600 gtk_widget_queue_resize (GTK_WIDGET (container));
604 gtk_paned_get_child_property (GtkContainer *container,
610 GtkPaned *paned = GTK_PANED (container);
612 g_assert (child == paned->child1 || child == paned->child2);
616 case CHILD_PROP_RESIZE:
617 if (child == paned->child1)
618 g_value_set_boolean (value, paned->child1_resize);
620 g_value_set_boolean (value, paned->child2_resize);
622 case CHILD_PROP_SHRINK:
623 if (child == paned->child1)
624 g_value_set_boolean (value, paned->child1_shrink);
626 g_value_set_boolean (value, paned->child2_shrink);
629 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
635 gtk_paned_finalize (GObject *object)
637 GtkPaned *paned = GTK_PANED (object);
639 gtk_paned_set_saved_focus (paned, NULL);
640 gtk_paned_set_first_paned (paned, NULL);
642 g_free (paned->priv);
644 G_OBJECT_CLASS (parent_class)->finalize (object);
648 gtk_paned_realize (GtkWidget *widget)
651 GdkWindowAttr attributes;
652 gint attributes_mask;
654 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
655 paned = GTK_PANED (widget);
657 widget->window = gtk_widget_get_parent_window (widget);
658 g_object_ref (widget->window);
660 attributes.window_type = GDK_WINDOW_CHILD;
661 attributes.wclass = GDK_INPUT_ONLY;
662 attributes.x = paned->handle_pos.x;
663 attributes.y = paned->handle_pos.y;
664 attributes.width = paned->handle_pos.width;
665 attributes.height = paned->handle_pos.height;
666 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
668 attributes.event_mask = gtk_widget_get_events (widget);
669 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
670 GDK_BUTTON_RELEASE_MASK |
671 GDK_ENTER_NOTIFY_MASK |
672 GDK_LEAVE_NOTIFY_MASK |
673 GDK_POINTER_MOTION_MASK |
674 GDK_POINTER_MOTION_HINT_MASK);
675 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_CURSOR;
677 paned->handle = gdk_window_new (widget->window,
678 &attributes, attributes_mask);
679 gdk_window_set_user_data (paned->handle, paned);
680 gdk_cursor_unref (attributes.cursor);
682 widget->style = gtk_style_attach (widget->style, widget->window);
684 if (paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
685 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
686 gdk_window_show (paned->handle);
690 gtk_paned_unrealize (GtkWidget *widget)
692 GtkPaned *paned = GTK_PANED (widget);
696 g_object_unref (paned->xor_gc);
697 paned->xor_gc = NULL;
702 gdk_window_set_user_data (paned->handle, NULL);
703 gdk_window_destroy (paned->handle);
704 paned->handle = NULL;
707 gtk_paned_set_last_child1_focus (paned, NULL);
708 gtk_paned_set_last_child2_focus (paned, NULL);
709 gtk_paned_set_saved_focus (paned, NULL);
710 gtk_paned_set_first_paned (paned, NULL);
712 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
713 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
717 gtk_paned_map (GtkWidget *widget)
719 GtkPaned *paned = GTK_PANED (widget);
721 gdk_window_show (paned->handle);
723 GTK_WIDGET_CLASS (parent_class)->map (widget);
727 gtk_paned_unmap (GtkWidget *widget)
729 GtkPaned *paned = GTK_PANED (widget);
731 gdk_window_hide (paned->handle);
733 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
737 gtk_paned_expose (GtkWidget *widget,
738 GdkEventExpose *event)
740 GtkPaned *paned = GTK_PANED (widget);
742 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
743 paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
744 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
748 if (gtk_widget_is_focus (widget))
749 state = GTK_STATE_SELECTED;
750 else if (paned->handle_prelit)
751 state = GTK_STATE_PRELIGHT;
753 state = GTK_WIDGET_STATE (widget);
755 gtk_paint_handle (widget->style, widget->window,
756 state, GTK_SHADOW_NONE,
757 &paned->handle_pos, widget, "paned",
758 paned->handle_pos.x, paned->handle_pos.y,
759 paned->handle_pos.width, paned->handle_pos.height,
763 /* Chain up to draw children */
764 GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
770 is_rtl (GtkPaned *paned)
772 if (paned->orientation == GTK_ORIENTATION_VERTICAL &&
773 gtk_widget_get_direction (GTK_WIDGET (paned)) == GTK_TEXT_DIR_RTL)
782 update_drag (GtkPaned *paned)
788 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
789 gtk_widget_get_pointer (GTK_WIDGET (paned), NULL, &pos);
791 gtk_widget_get_pointer (GTK_WIDGET (paned), &pos, NULL);
793 pos -= paned->drag_pos;
797 gtk_widget_style_get (GTK_WIDGET (paned),
798 "handle-size", &handle_size,
801 size = GTK_WIDGET (paned)->allocation.width - pos - handle_size;
808 size -= GTK_CONTAINER (paned)->border_width;
810 size = CLAMP (size, paned->min_position, paned->max_position);
812 if (size != paned->child1_size)
813 gtk_paned_set_position (paned, size);
817 gtk_paned_enter (GtkWidget *widget,
818 GdkEventCrossing *event)
820 GtkPaned *paned = GTK_PANED (widget);
826 paned->handle_prelit = TRUE;
827 gtk_widget_queue_draw_area (widget,
830 paned->handle_pos.width,
831 paned->handle_pos.height);
838 gtk_paned_leave (GtkWidget *widget,
839 GdkEventCrossing *event)
841 GtkPaned *paned = GTK_PANED (widget);
847 paned->handle_prelit = FALSE;
848 gtk_widget_queue_draw_area (widget,
851 paned->handle_pos.width,
852 paned->handle_pos.height);
859 gtk_paned_focus (GtkWidget *widget,
860 GtkDirectionType direction)
865 /* This is a hack, but how can this be done without
866 * excessive cut-and-paste from gtkcontainer.c?
869 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
870 retval = (* GTK_WIDGET_CLASS (parent_class)->focus) (widget, direction);
871 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
877 gtk_paned_button_press (GtkWidget *widget,
878 GdkEventButton *event)
880 GtkPaned *paned = GTK_PANED (widget);
882 if (!paned->in_drag &&
883 (event->window == paned->handle) && (event->button == 1))
885 paned->in_drag = TRUE;
887 /* We need a server grab here, not gtk_grab_add(), since
888 * we don't want to pass events on to the widget's children */
889 gdk_pointer_grab (paned->handle, FALSE,
890 GDK_POINTER_MOTION_HINT_MASK
891 | GDK_BUTTON1_MOTION_MASK
892 | GDK_BUTTON_RELEASE_MASK
893 | GDK_ENTER_NOTIFY_MASK
894 | GDK_LEAVE_NOTIFY_MASK,
898 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
899 paned->drag_pos = event->y;
901 paned->drag_pos = event->x;
910 gtk_paned_button_release (GtkWidget *widget,
911 GdkEventButton *event)
913 GtkPaned *paned = GTK_PANED (widget);
915 if (paned->in_drag && (event->button == 1))
917 paned->in_drag = FALSE;
918 paned->drag_pos = -1;
919 paned->position_set = TRUE;
920 gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
929 gtk_paned_motion (GtkWidget *widget,
930 GdkEventMotion *event)
932 GtkPaned *paned = GTK_PANED (widget);
944 gtk_paned_add1 (GtkPaned *paned,
947 gtk_paned_pack1 (paned, widget, FALSE, TRUE);
951 gtk_paned_add2 (GtkPaned *paned,
954 gtk_paned_pack2 (paned, widget, TRUE, TRUE);
958 gtk_paned_pack1 (GtkPaned *paned,
963 g_return_if_fail (GTK_IS_PANED (paned));
964 g_return_if_fail (GTK_IS_WIDGET (child));
968 paned->child1 = child;
969 paned->child1_resize = resize;
970 paned->child1_shrink = shrink;
972 gtk_widget_set_parent (child, GTK_WIDGET (paned));
977 gtk_paned_pack2 (GtkPaned *paned,
982 g_return_if_fail (GTK_IS_PANED (paned));
983 g_return_if_fail (GTK_IS_WIDGET (child));
987 paned->child2 = child;
988 paned->child2_resize = resize;
989 paned->child2_shrink = shrink;
991 gtk_widget_set_parent (child, GTK_WIDGET (paned));
997 gtk_paned_add (GtkContainer *container,
1002 g_return_if_fail (GTK_IS_PANED (container));
1004 paned = GTK_PANED (container);
1007 gtk_paned_add1 (paned, widget);
1008 else if (!paned->child2)
1009 gtk_paned_add2 (paned, widget);
1013 gtk_paned_remove (GtkContainer *container,
1017 gboolean was_visible;
1019 paned = GTK_PANED (container);
1020 was_visible = GTK_WIDGET_VISIBLE (widget);
1022 if (paned->child1 == widget)
1024 gtk_widget_unparent (widget);
1026 paned->child1 = NULL;
1028 if (was_visible && GTK_WIDGET_VISIBLE (container))
1029 gtk_widget_queue_resize (GTK_WIDGET (container));
1031 else if (paned->child2 == widget)
1033 gtk_widget_unparent (widget);
1035 paned->child2 = NULL;
1037 if (was_visible && GTK_WIDGET_VISIBLE (container))
1038 gtk_widget_queue_resize (GTK_WIDGET (container));
1043 gtk_paned_forall (GtkContainer *container,
1044 gboolean include_internals,
1045 GtkCallback callback,
1046 gpointer callback_data)
1050 g_return_if_fail (callback != NULL);
1052 paned = GTK_PANED (container);
1055 (*callback) (paned->child1, callback_data);
1057 (*callback) (paned->child2, callback_data);
1061 * gtk_paned_get_position:
1062 * @paned: a #GtkPaned widget
1064 * Obtains the position of the divider between the two panes.
1066 * Return value: position of the divider
1069 gtk_paned_get_position (GtkPaned *paned)
1071 g_return_val_if_fail (GTK_IS_PANED (paned), 0);
1073 return paned->child1_size;
1077 * gtk_paned_set_position:
1078 * @paned: a #GtkPaned widget
1079 * @position: pixel position of divider, a negative value means that the position
1082 * Sets the position of the divider between the two panes.
1085 gtk_paned_set_position (GtkPaned *paned,
1090 g_return_if_fail (GTK_IS_PANED (paned));
1092 object = G_OBJECT (paned);
1096 /* We don't clamp here - the assumption is that
1097 * if the total allocation changes at the same time
1098 * as the position, the position set is with reference
1099 * to the new total size. If only the position changes,
1100 * then clamping will occur in gtk_paned_compute_position()
1103 paned->child1_size = position;
1104 paned->position_set = TRUE;
1108 paned->position_set = FALSE;
1111 g_object_freeze_notify (object);
1112 g_object_notify (object, "position");
1113 g_object_notify (object, "position-set");
1114 g_object_thaw_notify (object);
1116 gtk_widget_queue_resize (GTK_WIDGET (paned));
1120 * gtk_paned_get_child1:
1121 * @paned: a #GtkPaned widget
1123 * Obtains the first child of the paned widget.
1125 * Return value: first child, or %NULL if it is not set.
1130 gtk_paned_get_child1 (GtkPaned *paned)
1132 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
1134 return paned->child1;
1138 * gtk_paned_get_child2:
1139 * @paned: a #GtkPaned widget
1141 * Obtains the second child of the paned widget.
1143 * Return value: second child, or %NULL if it is not set.
1148 gtk_paned_get_child2 (GtkPaned *paned)
1150 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
1152 return paned->child2;
1156 gtk_paned_compute_position (GtkPaned *paned,
1162 gint old_min_position;
1163 gint old_max_position;
1165 g_return_if_fail (GTK_IS_PANED (paned));
1167 old_position = paned->child1_size;
1168 old_min_position = paned->min_position;
1169 old_max_position = paned->max_position;
1171 paned->min_position = paned->child1_shrink ? 0 : child1_req;
1173 paned->max_position = allocation;
1174 if (!paned->child2_shrink)
1175 paned->max_position = MAX (1, paned->max_position - child2_req);
1176 paned->max_position = MAX (paned->min_position, paned->max_position);
1178 if (!paned->position_set)
1180 if (paned->child1_resize && !paned->child2_resize)
1181 paned->child1_size = MAX (0, allocation - child2_req);
1182 else if (!paned->child1_resize && paned->child2_resize)
1183 paned->child1_size = child1_req;
1184 else if (child1_req + child2_req != 0)
1185 paned->child1_size = allocation * ((gdouble)child1_req / (child1_req + child2_req)) + 0.5;
1187 paned->child1_size = allocation * 0.5 + 0.5;
1191 /* If the position was set before the initial allocation.
1192 * (paned->last_allocation <= 0) just clamp it and leave it.
1194 if (paned->last_allocation > 0)
1196 if (paned->child1_resize && !paned->child2_resize)
1197 paned->child1_size += allocation - paned->last_allocation;
1198 else if (!(!paned->child1_resize && paned->child2_resize))
1199 paned->child1_size = allocation * ((gdouble) paned->child1_size / (paned->last_allocation)) + 0.5;
1203 paned->child1_size = CLAMP (paned->child1_size,
1204 paned->min_position,
1205 paned->max_position);
1207 gtk_widget_set_child_visible (paned->child1, paned->child1_size != 0);
1208 gtk_widget_set_child_visible (paned->child2, paned->child1_size != allocation);
1210 g_object_freeze_notify (G_OBJECT (paned));
1211 if (paned->child1_size != old_position)
1212 g_object_notify (G_OBJECT (paned), "position");
1213 if (paned->min_position != old_min_position)
1214 g_object_notify (G_OBJECT (paned), "min-position");
1215 if (paned->max_position != old_max_position)
1216 g_object_notify (G_OBJECT (paned), "max-position");
1217 g_object_thaw_notify (G_OBJECT (paned));
1219 paned->last_allocation = allocation;
1223 gtk_paned_set_saved_focus (GtkPaned *paned, GtkWidget *widget)
1225 if (paned->priv->saved_focus)
1226 g_object_remove_weak_pointer (G_OBJECT (paned->priv->saved_focus),
1227 (gpointer *)&(paned->priv->saved_focus));
1229 paned->priv->saved_focus = widget;
1231 if (paned->priv->saved_focus)
1232 g_object_add_weak_pointer (G_OBJECT (paned->priv->saved_focus),
1233 (gpointer *)&(paned->priv->saved_focus));
1237 gtk_paned_set_first_paned (GtkPaned *paned, GtkPaned *first_paned)
1239 if (paned->priv->first_paned)
1240 g_object_remove_weak_pointer (G_OBJECT (paned->priv->first_paned),
1241 (gpointer *)&(paned->priv->first_paned));
1243 paned->priv->first_paned = first_paned;
1245 if (paned->priv->first_paned)
1246 g_object_add_weak_pointer (G_OBJECT (paned->priv->first_paned),
1247 (gpointer *)&(paned->priv->first_paned));
1251 gtk_paned_set_last_child1_focus (GtkPaned *paned, GtkWidget *widget)
1253 if (paned->last_child1_focus)
1254 g_object_remove_weak_pointer (G_OBJECT (paned->last_child1_focus),
1255 (gpointer *)&(paned->last_child1_focus));
1257 paned->last_child1_focus = widget;
1259 if (paned->last_child1_focus)
1260 g_object_add_weak_pointer (G_OBJECT (paned->last_child1_focus),
1261 (gpointer *)&(paned->last_child1_focus));
1265 gtk_paned_set_last_child2_focus (GtkPaned *paned, GtkWidget *widget)
1267 if (paned->last_child2_focus)
1268 g_object_remove_weak_pointer (G_OBJECT (paned->last_child2_focus),
1269 (gpointer *)&(paned->last_child2_focus));
1271 paned->last_child2_focus = widget;
1273 if (paned->last_child2_focus)
1274 g_object_add_weak_pointer (G_OBJECT (paned->last_child2_focus),
1275 (gpointer *)&(paned->last_child2_focus));
1279 paned_get_focus_widget (GtkPaned *paned)
1281 GtkWidget *toplevel;
1283 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1284 if (GTK_WIDGET_TOPLEVEL (toplevel))
1285 return GTK_WINDOW (toplevel)->focus_widget;
1291 gtk_paned_set_focus_child (GtkContainer *container,
1292 GtkWidget *focus_child)
1296 g_return_if_fail (GTK_IS_PANED (container));
1298 paned = GTK_PANED (container);
1300 if (focus_child == NULL)
1302 GtkWidget *last_focus;
1305 last_focus = paned_get_focus_widget (paned);
1309 /* If there is one or more paned widgets between us and the
1310 * focus widget, we want the topmost of those as last_focus
1312 for (w = last_focus; w != GTK_WIDGET (paned); w = w->parent)
1313 if (GTK_IS_PANED (w))
1316 if (container->focus_child == paned->child1)
1317 gtk_paned_set_last_child1_focus (paned, last_focus);
1318 else if (container->focus_child == paned->child2)
1319 gtk_paned_set_last_child2_focus (paned, last_focus);
1323 if (parent_class->set_focus_child)
1324 (* parent_class->set_focus_child) (container, focus_child);
1328 gtk_paned_get_cycle_chain (GtkPaned *paned,
1329 GtkDirectionType direction,
1332 GtkContainer *container = GTK_CONTAINER (paned);
1333 GtkWidget *ancestor = NULL;
1334 GList *temp_list = NULL;
1337 if (paned->in_recursion)
1340 g_assert (widgets != NULL);
1342 if (paned->last_child1_focus &&
1343 !gtk_widget_is_ancestor (paned->last_child1_focus, GTK_WIDGET (paned)))
1345 gtk_paned_set_last_child1_focus (paned, NULL);
1348 if (paned->last_child2_focus &&
1349 !gtk_widget_is_ancestor (paned->last_child2_focus, GTK_WIDGET (paned)))
1351 gtk_paned_set_last_child2_focus (paned, NULL);
1354 if (GTK_WIDGET (paned)->parent)
1355 ancestor = gtk_widget_get_ancestor (GTK_WIDGET (paned)->parent, GTK_TYPE_PANED);
1357 /* The idea here is that temp_list is a list of widgets we want to cycle
1358 * to. The list is prioritized so that the first element is our first
1359 * choice, the next our second, and so on.
1361 * We can't just use g_list_reverse(), because we want to try
1362 * paned->last_child?_focus before paned->child?, both when we
1363 * are going forward and backward.
1365 if (direction == GTK_DIR_TAB_FORWARD)
1367 if (container->focus_child == paned->child1)
1369 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1370 temp_list = g_list_append (temp_list, paned->child2);
1371 temp_list = g_list_append (temp_list, ancestor);
1373 else if (container->focus_child == paned->child2)
1375 temp_list = g_list_append (temp_list, ancestor);
1376 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1377 temp_list = g_list_append (temp_list, paned->child1);
1381 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1382 temp_list = g_list_append (temp_list, paned->child1);
1383 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1384 temp_list = g_list_append (temp_list, paned->child2);
1385 temp_list = g_list_append (temp_list, ancestor);
1390 if (container->focus_child == paned->child1)
1392 temp_list = g_list_append (temp_list, ancestor);
1393 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1394 temp_list = g_list_append (temp_list, paned->child2);
1396 else if (container->focus_child == paned->child2)
1398 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1399 temp_list = g_list_append (temp_list, paned->child1);
1400 temp_list = g_list_append (temp_list, ancestor);
1404 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1405 temp_list = g_list_append (temp_list, paned->child2);
1406 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1407 temp_list = g_list_append (temp_list, paned->child1);
1408 temp_list = g_list_append (temp_list, ancestor);
1412 /* Walk the list and expand all the paned widgets. */
1413 for (list = temp_list; list != NULL; list = list->next)
1415 GtkWidget *widget = list->data;
1419 if (GTK_IS_PANED (widget))
1421 paned->in_recursion = TRUE;
1422 gtk_paned_get_cycle_chain (GTK_PANED (widget), direction, widgets);
1423 paned->in_recursion = FALSE;
1427 *widgets = g_list_append (*widgets, widget);
1432 g_list_free (temp_list);
1436 gtk_paned_cycle_child_focus (GtkPaned *paned,
1439 GList *cycle_chain = NULL;
1442 GtkDirectionType direction = reversed? GTK_DIR_TAB_BACKWARD : GTK_DIR_TAB_FORWARD;
1444 /* ignore f6 if the handle is focused */
1445 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1448 /* we can't just let the event propagate up the hierarchy,
1449 * because the paned will want to cycle focus _unless_ an
1450 * ancestor paned handles the event
1452 gtk_paned_get_cycle_chain (paned, direction, &cycle_chain);
1454 for (list = cycle_chain; list != NULL; list = list->next)
1455 if (gtk_widget_child_focus (GTK_WIDGET (list->data), direction))
1458 g_list_free (cycle_chain);
1464 get_child_panes (GtkWidget *widget,
1467 if (GTK_IS_PANED (widget))
1469 GtkPaned *paned = GTK_PANED (widget);
1471 get_child_panes (paned->child1, panes);
1472 *panes = g_list_prepend (*panes, widget);
1473 get_child_panes (paned->child2, panes);
1475 else if (GTK_IS_CONTAINER (widget))
1477 gtk_container_foreach (GTK_CONTAINER (widget),
1478 (GtkCallback)get_child_panes, panes);
1483 get_all_panes (GtkPaned *paned)
1485 GtkPaned *topmost = NULL;
1486 GList *result = NULL;
1489 for (w = GTK_WIDGET (paned); w != NULL; w = w->parent)
1491 if (GTK_IS_PANED (w))
1492 topmost = GTK_PANED (w);
1497 get_child_panes (GTK_WIDGET (topmost), &result);
1499 return g_list_reverse (result);
1503 gtk_paned_find_neighbours (GtkPaned *paned,
1510 all_panes = get_all_panes (paned);
1511 g_assert (all_panes);
1513 this_link = g_list_find (all_panes, paned);
1515 g_assert (this_link);
1517 if (this_link->next)
1518 *next = this_link->next->data;
1520 *next = all_panes->data;
1522 if (this_link->prev)
1523 *prev = this_link->prev->data;
1525 *prev = g_list_last (all_panes)->data;
1527 g_list_free (all_panes);
1531 gtk_paned_move_handle (GtkPaned *paned,
1532 GtkScrollType scroll)
1534 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1541 SINGLE_STEP_SIZE = 1,
1545 new_position = old_position = gtk_paned_get_position (paned);
1550 case GTK_SCROLL_STEP_LEFT:
1551 case GTK_SCROLL_STEP_UP:
1552 case GTK_SCROLL_STEP_BACKWARD:
1553 increment = - SINGLE_STEP_SIZE;
1556 case GTK_SCROLL_STEP_RIGHT:
1557 case GTK_SCROLL_STEP_DOWN:
1558 case GTK_SCROLL_STEP_FORWARD:
1559 increment = SINGLE_STEP_SIZE;
1562 case GTK_SCROLL_PAGE_LEFT:
1563 case GTK_SCROLL_PAGE_UP:
1564 case GTK_SCROLL_PAGE_BACKWARD:
1565 increment = - PAGE_STEP_SIZE;
1568 case GTK_SCROLL_PAGE_RIGHT:
1569 case GTK_SCROLL_PAGE_DOWN:
1570 case GTK_SCROLL_PAGE_FORWARD:
1571 increment = PAGE_STEP_SIZE;
1574 case GTK_SCROLL_START:
1575 new_position = paned->min_position;
1578 case GTK_SCROLL_END:
1579 new_position = paned->max_position;
1589 increment = -increment;
1591 new_position = old_position + increment;
1594 new_position = CLAMP (new_position, paned->min_position, paned->max_position);
1596 if (old_position != new_position)
1597 gtk_paned_set_position (paned, new_position);
1606 gtk_paned_restore_focus (GtkPaned *paned)
1608 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1610 if (paned->priv->saved_focus &&
1611 GTK_WIDGET_SENSITIVE (paned->priv->saved_focus))
1613 gtk_widget_grab_focus (paned->priv->saved_focus);
1617 /* the saved focus is somehow not available for focusing,
1619 * 1) tabbing into the paned widget
1620 * if that didn't work,
1621 * 2) unset focus for the window if there is one
1624 if (!gtk_widget_child_focus (GTK_WIDGET (paned), GTK_DIR_TAB_FORWARD))
1626 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1628 if (GTK_IS_WINDOW (toplevel))
1629 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1633 gtk_paned_set_saved_focus (paned, NULL);
1634 gtk_paned_set_first_paned (paned, NULL);
1639 gtk_paned_accept_position (GtkPaned *paned)
1641 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1643 paned->original_position = -1;
1644 gtk_paned_restore_focus (paned);
1654 gtk_paned_cancel_position (GtkPaned *paned)
1656 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1658 if (paned->original_position != -1)
1660 gtk_paned_set_position (paned, paned->original_position);
1661 paned->original_position = -1;
1664 gtk_paned_restore_focus (paned);
1672 gtk_paned_cycle_handle_focus (GtkPaned *paned,
1675 GtkPaned *next, *prev;
1677 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1679 GtkPaned *focus = NULL;
1681 if (!paned->priv->first_paned)
1683 /* The first_pane has disappeared. As an ad-hoc solution,
1684 * we make the currently focused paned the first_paned. To the
1685 * user this will seem like the paned cycling has been reset.
1688 gtk_paned_set_first_paned (paned, paned);
1691 gtk_paned_find_neighbours (paned, &next, &prev);
1693 if (reversed && prev &&
1694 prev != paned && paned != paned->priv->first_paned)
1698 else if (!reversed && next &&
1699 next != paned && next != paned->priv->first_paned)
1705 gtk_paned_accept_position (paned);
1711 gtk_paned_set_saved_focus (focus, paned->priv->saved_focus);
1712 gtk_paned_set_first_paned (focus, paned->priv->first_paned);
1714 gtk_paned_set_saved_focus (paned, NULL);
1715 gtk_paned_set_first_paned (paned, NULL);
1717 gtk_widget_grab_focus (GTK_WIDGET (focus));
1719 if (!gtk_widget_is_focus (GTK_WIDGET (paned)))
1721 paned->original_position = -1;
1722 focus->original_position = gtk_paned_get_position (focus);
1727 GtkContainer *container = GTK_CONTAINER (paned);
1730 GtkPaned *prev, *next;
1731 GtkWidget *toplevel;
1733 gtk_paned_find_neighbours (paned, &next, &prev);
1735 if (container->focus_child == paned->child1)
1748 else if (container->focus_child == paned->child2)
1763 /* Focus is not inside this paned, and we don't have focus.
1764 * Presumably this happened because the application wants us
1765 * to start keyboard navigating.
1775 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1777 if (GTK_IS_WINDOW (toplevel))
1778 gtk_paned_set_saved_focus (focus, GTK_WINDOW (toplevel)->focus_widget);
1779 gtk_paned_set_first_paned (focus, first);
1780 focus->original_position = gtk_paned_get_position (focus);
1782 gtk_widget_grab_focus (GTK_WIDGET (focus));
1789 gtk_paned_toggle_handle_focus (GtkPaned *paned)
1791 /* This function/signal has the wrong name. It is called when you
1792 * press Tab or Shift-Tab and what we do is act as if
1793 * the user pressed Return and then Tab or Shift-Tab
1795 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1796 gtk_paned_accept_position (paned);
1801 #define __GTK_PANED_C__
1802 #include "gtkaliasdef.c"