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/.
31 #include "gtkbindings.h"
33 #include "gtkmarshalers.h"
34 #include "gtkorientable.h"
35 #include "gtkwindow.h"
36 #include "gtktypebuiltins.h"
37 #include "gtkprivate.h"
43 * @Short_description: Base class for widgets with two adjustable panes
46 * #GtkPaned is the base class for widgets with two panes, arranged either
47 * horizontally (#GtkHPaned) or vertically (#GtkVPaned). Child widgets are
48 * added to the panes of the widget with gtk_paned_pack1() and
49 * gtk_paned_pack2(). The division between the two children is set by default
50 * from the size requests of the children, but it can be adjusted by the
53 * A paned widget draws a separator between the two child widgets and a
54 * small handle that the user can drag to adjust the division. It does not
55 * draw any relief around the children or around the separator. (The space
56 * in which the separator is called the gutter.) Often, it is useful to put
57 * each child inside a #GtkFrame with the shadow type set to %GTK_SHADOW_IN
58 * so that the gutter appears as a ridge. No separator is drawn if one of
59 * the children is missing.
61 * Each child has two options that can be set, @resize and @shrink. If
62 * @resize is true, then when the #GtkPaned is resized, that child will
63 * expand or shrink along with the paned widget. If @shrink is true, then
64 * that child can be made smaller than its requisition by the user.
65 * Setting @shrink to %FALSE allows the application to set a minimum size.
66 * If @resize is false for both children, then this is treated as if
67 * @resize is true for both children.
69 * The application can set the position of the slider as if it were set
70 * by the user, by calling gtk_paned_set_position().
73 * <title>Creating a paned widget with minimum sizes.</title>
75 * GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL);
76 * GtkWidget *frame1 = gtk_frame_new (NULL);
77 * GtkWidget *frame2 = gtk_frame_new (NULL);
78 * gtk_frame_set_shadow_type (GTK_FRAME (frame1), GTK_SHADOW_IN);
79 * gtk_frame_set_shadow_type (GTK_FRAME (frame2), GTK_SHADOW_IN);
81 * gtk_widget_set_size_request (hpaned, 200, -1);
83 * gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE);
84 * gtk_widget_set_size_request (frame1, 50, -1);
86 * gtk_paned_pack2 (GTK_PANED (hpaned), frame2, FALSE, FALSE);
87 * gtk_widget_set_size_request (frame2, 50, -1);
92 struct _GtkPanedPrivate
94 GtkOrientation orientation;
95 GtkPaned *first_paned;
98 GtkWidget *last_child1_focus;
99 GtkWidget *last_child2_focus;
100 GtkWidget *saved_focus;
102 GdkCursorType cursor_type;
103 GdkDevice *grab_device;
104 GdkRectangle handle_pos;
109 gint last_allocation;
112 gint original_position;
114 guint handle_prelit : 1;
116 guint in_recursion : 1;
117 guint child1_resize : 1;
118 guint child1_shrink : 1;
119 guint child2_resize : 1;
120 guint child2_shrink : 1;
121 guint position_set : 1;
151 static void gtk_paned_set_property (GObject *object,
155 static void gtk_paned_get_property (GObject *object,
159 static void gtk_paned_set_child_property (GtkContainer *container,
164 static void gtk_paned_get_child_property (GtkContainer *container,
169 static void gtk_paned_finalize (GObject *object);
171 static void gtk_paned_get_preferred_width (GtkWidget *widget,
174 static void gtk_paned_get_preferred_height (GtkWidget *widget,
178 static void gtk_paned_size_allocate (GtkWidget *widget,
179 GtkAllocation *allocation);
180 static void gtk_paned_realize (GtkWidget *widget);
181 static void gtk_paned_unrealize (GtkWidget *widget);
182 static void gtk_paned_map (GtkWidget *widget);
183 static void gtk_paned_unmap (GtkWidget *widget);
184 static void gtk_paned_state_flags_changed (GtkWidget *widget,
185 GtkStateFlags previous_state);
186 static gboolean gtk_paned_draw (GtkWidget *widget,
188 static gboolean gtk_paned_enter (GtkWidget *widget,
189 GdkEventCrossing *event);
190 static gboolean gtk_paned_leave (GtkWidget *widget,
191 GdkEventCrossing *event);
192 static gboolean gtk_paned_button_press (GtkWidget *widget,
193 GdkEventButton *event);
194 static gboolean gtk_paned_button_release (GtkWidget *widget,
195 GdkEventButton *event);
196 static gboolean gtk_paned_motion (GtkWidget *widget,
197 GdkEventMotion *event);
198 static gboolean gtk_paned_focus (GtkWidget *widget,
199 GtkDirectionType direction);
200 static gboolean gtk_paned_grab_broken (GtkWidget *widget,
201 GdkEventGrabBroken *event);
202 static void gtk_paned_add (GtkContainer *container,
204 static void gtk_paned_remove (GtkContainer *container,
206 static void gtk_paned_forall (GtkContainer *container,
207 gboolean include_internals,
208 GtkCallback callback,
209 gpointer callback_data);
210 static void gtk_paned_calc_position (GtkPaned *paned,
214 static void gtk_paned_set_focus_child (GtkContainer *container,
216 static void gtk_paned_set_saved_focus (GtkPaned *paned,
218 static void gtk_paned_set_first_paned (GtkPaned *paned,
219 GtkPaned *first_paned);
220 static void gtk_paned_set_last_child1_focus (GtkPaned *paned,
222 static void gtk_paned_set_last_child2_focus (GtkPaned *paned,
224 static gboolean gtk_paned_cycle_child_focus (GtkPaned *paned,
226 static gboolean gtk_paned_cycle_handle_focus (GtkPaned *paned,
228 static gboolean gtk_paned_move_handle (GtkPaned *paned,
229 GtkScrollType scroll);
230 static gboolean gtk_paned_accept_position (GtkPaned *paned);
231 static gboolean gtk_paned_cancel_position (GtkPaned *paned);
232 static gboolean gtk_paned_toggle_handle_focus (GtkPaned *paned);
234 static GType gtk_paned_child_type (GtkContainer *container);
235 static void gtk_paned_grab_notify (GtkWidget *widget,
236 gboolean was_grabbed);
239 G_DEFINE_TYPE_WITH_CODE (GtkPaned, gtk_paned, GTK_TYPE_CONTAINER,
240 G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE,
243 static guint signals[LAST_SIGNAL] = { 0 };
247 add_tab_bindings (GtkBindingSet *binding_set,
248 GdkModifierType modifiers)
250 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Tab, modifiers,
251 "toggle-handle-focus", 0);
252 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Tab, modifiers,
253 "toggle-handle-focus", 0);
257 add_move_binding (GtkBindingSet *binding_set,
259 GdkModifierType mask,
260 GtkScrollType scroll)
262 gtk_binding_entry_add_signal (binding_set, keyval, mask,
264 GTK_TYPE_SCROLL_TYPE, scroll);
268 gtk_paned_class_init (GtkPanedClass *class)
270 GObjectClass *object_class;
271 GtkWidgetClass *widget_class;
272 GtkContainerClass *container_class;
273 GtkPanedClass *paned_class;
274 GtkBindingSet *binding_set;
276 object_class = (GObjectClass *) class;
277 widget_class = (GtkWidgetClass *) class;
278 container_class = (GtkContainerClass *) class;
279 paned_class = (GtkPanedClass *) class;
281 object_class->set_property = gtk_paned_set_property;
282 object_class->get_property = gtk_paned_get_property;
283 object_class->finalize = gtk_paned_finalize;
285 widget_class->get_preferred_width = gtk_paned_get_preferred_width;
286 widget_class->get_preferred_height = gtk_paned_get_preferred_height;
287 widget_class->size_allocate = gtk_paned_size_allocate;
288 widget_class->realize = gtk_paned_realize;
289 widget_class->unrealize = gtk_paned_unrealize;
290 widget_class->map = gtk_paned_map;
291 widget_class->unmap = gtk_paned_unmap;
292 widget_class->draw = gtk_paned_draw;
293 widget_class->focus = gtk_paned_focus;
294 widget_class->enter_notify_event = gtk_paned_enter;
295 widget_class->leave_notify_event = gtk_paned_leave;
296 widget_class->button_press_event = gtk_paned_button_press;
297 widget_class->button_release_event = gtk_paned_button_release;
298 widget_class->motion_notify_event = gtk_paned_motion;
299 widget_class->grab_broken_event = gtk_paned_grab_broken;
300 widget_class->grab_notify = gtk_paned_grab_notify;
301 widget_class->state_flags_changed = gtk_paned_state_flags_changed;
303 container_class->add = gtk_paned_add;
304 container_class->remove = gtk_paned_remove;
305 container_class->forall = gtk_paned_forall;
306 container_class->child_type = gtk_paned_child_type;
307 container_class->set_focus_child = gtk_paned_set_focus_child;
308 container_class->set_child_property = gtk_paned_set_child_property;
309 container_class->get_child_property = gtk_paned_get_child_property;
310 gtk_container_class_handle_border_width (container_class);
312 paned_class->cycle_child_focus = gtk_paned_cycle_child_focus;
313 paned_class->toggle_handle_focus = gtk_paned_toggle_handle_focus;
314 paned_class->move_handle = gtk_paned_move_handle;
315 paned_class->cycle_handle_focus = gtk_paned_cycle_handle_focus;
316 paned_class->accept_position = gtk_paned_accept_position;
317 paned_class->cancel_position = gtk_paned_cancel_position;
319 g_object_class_override_property (object_class,
323 g_object_class_install_property (object_class,
325 g_param_spec_int ("position",
327 P_("Position of paned separator in pixels (0 means all the way to the left/top)"),
331 GTK_PARAM_READWRITE));
333 g_object_class_install_property (object_class,
335 g_param_spec_boolean ("position-set",
337 P_("TRUE if the Position property should be used"),
339 GTK_PARAM_READWRITE));
341 gtk_widget_class_install_style_property (widget_class,
342 g_param_spec_int ("handle-size",
344 P_("Width of handle"),
348 GTK_PARAM_READABLE));
350 * GtkPaned:min-position:
352 * The smallest possible value for the position property. This property is derived from the
353 * size and shrinkability of the widget's children.
357 g_object_class_install_property (object_class,
359 g_param_spec_int ("min-position",
360 P_("Minimal Position"),
361 P_("Smallest possible value for the \"position\" property"),
365 GTK_PARAM_READABLE));
368 * GtkPaned:max-position:
370 * The largest possible value for the position property. This property is derived from the
371 * size and shrinkability of the widget's children.
375 g_object_class_install_property (object_class,
377 g_param_spec_int ("max-position",
378 P_("Maximal Position"),
379 P_("Largest possible value for the \"position\" property"),
383 GTK_PARAM_READABLE));
388 * The "resize" child property determines whether the child expands and
389 * shrinks along with the paned widget.
393 gtk_container_class_install_child_property (container_class,
395 g_param_spec_boolean ("resize",
397 P_("If TRUE, the child expands and shrinks along with the paned widget"),
399 GTK_PARAM_READWRITE));
404 * The "shrink" child property determines whether the child can be made
405 * smaller than its requisition.
409 gtk_container_class_install_child_property (container_class,
411 g_param_spec_boolean ("shrink",
413 P_("If TRUE, the child can be made smaller than its requisition"),
415 GTK_PARAM_READWRITE));
418 * GtkPaned::cycle-child-focus:
419 * @widget: the object that received the signal
420 * @reversed: whether cycling backward or forward
422 * The ::cycle-child-focus signal is a
423 * <link linkend="keybinding-signals">keybinding signal</link>
424 * which gets emitted to cycle the focus between the children of the paned.
426 * The default binding is f6.
430 signals [CYCLE_CHILD_FOCUS] =
431 g_signal_new (I_("cycle-child-focus"),
432 G_TYPE_FROM_CLASS (object_class),
433 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
434 G_STRUCT_OFFSET (GtkPanedClass, cycle_child_focus),
436 _gtk_marshal_BOOLEAN__BOOLEAN,
441 * GtkPaned::toggle-handle-focus:
442 * @widget: the object that received the signal
444 * The ::toggle-handle-focus is a
445 * <link linkend="keybinding-signals">keybinding signal</link>
446 * which gets emitted to accept the current position of the handle and then
447 * move focus to the next widget in the focus chain.
449 * The default binding is Tab.
453 signals [TOGGLE_HANDLE_FOCUS] =
454 g_signal_new (I_("toggle-handle-focus"),
455 G_TYPE_FROM_CLASS (object_class),
456 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
457 G_STRUCT_OFFSET (GtkPanedClass, toggle_handle_focus),
459 _gtk_marshal_BOOLEAN__VOID,
463 * GtkPaned::move-handle:
464 * @widget: the object that received the signal
465 * @scroll_type: a #GtkScrollType
467 * The ::move-handle signal is a
468 * <link linkend="keybinding-signals">keybinding signal</link>
469 * which gets emitted to move the handle when the user is using key bindings
474 signals[MOVE_HANDLE] =
475 g_signal_new (I_("move-handle"),
476 G_TYPE_FROM_CLASS (object_class),
477 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
478 G_STRUCT_OFFSET (GtkPanedClass, move_handle),
480 _gtk_marshal_BOOLEAN__ENUM,
482 GTK_TYPE_SCROLL_TYPE);
485 * GtkPaned::cycle-handle-focus:
486 * @widget: the object that received the signal
487 * @reversed: whether cycling backward or forward
489 * The ::cycle-handle-focus signal is a
490 * <link linkend="keybinding-signals">keybinding signal</link>
491 * which gets emitted to cycle whether the paned should grab focus to allow
492 * the user to change position of the handle by using key bindings.
494 * The default binding for this signal is f8.
498 signals [CYCLE_HANDLE_FOCUS] =
499 g_signal_new (I_("cycle-handle-focus"),
500 G_TYPE_FROM_CLASS (object_class),
501 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
502 G_STRUCT_OFFSET (GtkPanedClass, cycle_handle_focus),
504 _gtk_marshal_BOOLEAN__BOOLEAN,
509 * GtkPaned::accept-position:
510 * @widget: the object that received the signal
512 * The ::accept-position signal is a
513 * <link linkend="keybinding-signals">keybinding signal</link>
514 * which gets emitted to accept the current position of the handle when
515 * moving it using key bindings.
517 * The default binding for this signal is Return or Space.
521 signals [ACCEPT_POSITION] =
522 g_signal_new (I_("accept-position"),
523 G_TYPE_FROM_CLASS (object_class),
524 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
525 G_STRUCT_OFFSET (GtkPanedClass, accept_position),
527 _gtk_marshal_BOOLEAN__VOID,
531 * GtkPaned::cancel-position:
532 * @widget: the object that received the signal
534 * The ::cancel-position signal is a
535 * <link linkend="keybinding-signals">keybinding signal</link>
536 * which gets emitted to cancel moving the position of the handle using key
537 * bindings. The position of the handle will be reset to the value prior to
540 * The default binding for this signal is Escape.
544 signals [CANCEL_POSITION] =
545 g_signal_new (I_("cancel-position"),
546 G_TYPE_FROM_CLASS (object_class),
547 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
548 G_STRUCT_OFFSET (GtkPanedClass, cancel_position),
550 _gtk_marshal_BOOLEAN__VOID,
553 binding_set = gtk_binding_set_by_class (class);
556 gtk_binding_entry_add_signal (binding_set,
558 "cycle-child-focus", 1,
559 G_TYPE_BOOLEAN, FALSE);
560 gtk_binding_entry_add_signal (binding_set,
561 GDK_KEY_F6, GDK_SHIFT_MASK,
562 "cycle-child-focus", 1,
563 G_TYPE_BOOLEAN, TRUE);
566 gtk_binding_entry_add_signal (binding_set,
568 "cycle-handle-focus", 1,
569 G_TYPE_BOOLEAN, FALSE);
571 gtk_binding_entry_add_signal (binding_set,
572 GDK_KEY_F8, GDK_SHIFT_MASK,
573 "cycle-handle-focus", 1,
574 G_TYPE_BOOLEAN, TRUE);
576 add_tab_bindings (binding_set, 0);
577 add_tab_bindings (binding_set, GDK_CONTROL_MASK);
578 add_tab_bindings (binding_set, GDK_SHIFT_MASK);
579 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK);
581 /* accept and cancel positions */
582 gtk_binding_entry_add_signal (binding_set,
584 "cancel-position", 0);
586 gtk_binding_entry_add_signal (binding_set,
588 "accept-position", 0);
589 gtk_binding_entry_add_signal (binding_set,
590 GDK_KEY_ISO_Enter, 0,
591 "accept-position", 0);
592 gtk_binding_entry_add_signal (binding_set,
594 "accept-position", 0);
595 gtk_binding_entry_add_signal (binding_set,
597 "accept-position", 0);
598 gtk_binding_entry_add_signal (binding_set,
600 "accept-position", 0);
603 add_move_binding (binding_set, GDK_KEY_Left, 0, GTK_SCROLL_STEP_LEFT);
604 add_move_binding (binding_set, GDK_KEY_KP_Left, 0, GTK_SCROLL_STEP_LEFT);
605 add_move_binding (binding_set, GDK_KEY_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
606 add_move_binding (binding_set, GDK_KEY_KP_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
608 add_move_binding (binding_set, GDK_KEY_Right, 0, GTK_SCROLL_STEP_RIGHT);
609 add_move_binding (binding_set, GDK_KEY_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
610 add_move_binding (binding_set, GDK_KEY_KP_Right, 0, GTK_SCROLL_STEP_RIGHT);
611 add_move_binding (binding_set, GDK_KEY_KP_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
613 add_move_binding (binding_set, GDK_KEY_Up, 0, GTK_SCROLL_STEP_UP);
614 add_move_binding (binding_set, GDK_KEY_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
615 add_move_binding (binding_set, GDK_KEY_KP_Up, 0, GTK_SCROLL_STEP_UP);
616 add_move_binding (binding_set, GDK_KEY_KP_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
617 add_move_binding (binding_set, GDK_KEY_Page_Up, 0, GTK_SCROLL_PAGE_UP);
618 add_move_binding (binding_set, GDK_KEY_KP_Page_Up, 0, GTK_SCROLL_PAGE_UP);
620 add_move_binding (binding_set, GDK_KEY_Down, 0, GTK_SCROLL_STEP_DOWN);
621 add_move_binding (binding_set, GDK_KEY_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
622 add_move_binding (binding_set, GDK_KEY_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
623 add_move_binding (binding_set, GDK_KEY_KP_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
624 add_move_binding (binding_set, GDK_KEY_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
625 add_move_binding (binding_set, GDK_KEY_KP_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
627 add_move_binding (binding_set, GDK_KEY_Home, 0, GTK_SCROLL_START);
628 add_move_binding (binding_set, GDK_KEY_KP_Home, 0, GTK_SCROLL_START);
629 add_move_binding (binding_set, GDK_KEY_End, 0, GTK_SCROLL_END);
630 add_move_binding (binding_set, GDK_KEY_KP_End, 0, GTK_SCROLL_END);
632 g_type_class_add_private (object_class, sizeof (GtkPanedPrivate));
636 gtk_paned_child_type (GtkContainer *container)
638 GtkPaned *paned = GTK_PANED (container);
639 GtkPanedPrivate *priv = paned->priv;
641 if (!priv->child1 || !priv->child2)
642 return GTK_TYPE_WIDGET;
648 gtk_paned_init (GtkPaned *paned)
650 GtkPanedPrivate *priv;
652 gtk_widget_set_has_window (GTK_WIDGET (paned), FALSE);
653 gtk_widget_set_can_focus (GTK_WIDGET (paned), TRUE);
655 /* We only need to redraw when the handle position moves, which is
656 * independent of the overall allocation of the GtkPaned
658 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (paned), FALSE);
660 paned->priv = G_TYPE_INSTANCE_GET_PRIVATE (paned, GTK_TYPE_PANED, GtkPanedPrivate);
663 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
664 priv->cursor_type = GDK_SB_H_DOUBLE_ARROW;
669 priv->cursor_type = GDK_CROSS;
671 priv->handle_pos.width = 5;
672 priv->handle_pos.height = 5;
673 priv->position_set = FALSE;
674 priv->last_allocation = -1;
675 priv->in_drag = FALSE;
677 priv->last_child1_focus = NULL;
678 priv->last_child2_focus = NULL;
679 priv->in_recursion = FALSE;
680 priv->handle_prelit = FALSE;
681 priv->original_position = -1;
683 priv->handle_pos.x = -1;
684 priv->handle_pos.y = -1;
690 gtk_paned_set_property (GObject *object,
695 GtkPaned *paned = GTK_PANED (object);
696 GtkPanedPrivate *priv = paned->priv;
700 case PROP_ORIENTATION:
701 priv->orientation = g_value_get_enum (value);
703 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
704 priv->cursor_type = GDK_SB_H_DOUBLE_ARROW;
706 priv->cursor_type = GDK_SB_V_DOUBLE_ARROW;
708 /* state_flags_changed updates the cursor */
709 gtk_paned_state_flags_changed (GTK_WIDGET (paned), 0);
710 gtk_widget_queue_resize (GTK_WIDGET (paned));
713 gtk_paned_set_position (paned, g_value_get_int (value));
715 case PROP_POSITION_SET:
716 priv->position_set = g_value_get_boolean (value);
717 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (paned));
720 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
726 gtk_paned_get_property (GObject *object,
731 GtkPaned *paned = GTK_PANED (object);
732 GtkPanedPrivate *priv = paned->priv;
736 case PROP_ORIENTATION:
737 g_value_set_enum (value, priv->orientation);
740 g_value_set_int (value, priv->child1_size);
742 case PROP_POSITION_SET:
743 g_value_set_boolean (value, priv->position_set);
745 case PROP_MIN_POSITION:
746 g_value_set_int (value, priv->min_position);
748 case PROP_MAX_POSITION:
749 g_value_set_int (value, priv->max_position);
752 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
758 gtk_paned_set_child_property (GtkContainer *container,
764 GtkPaned *paned = GTK_PANED (container);
765 GtkPanedPrivate *priv = paned->priv;
766 gboolean old_value, new_value;
768 g_assert (child == priv->child1 || child == priv->child2);
770 new_value = g_value_get_boolean (value);
773 case CHILD_PROP_RESIZE:
774 if (child == priv->child1)
776 old_value = priv->child1_resize;
777 priv->child1_resize = new_value;
781 old_value = priv->child2_resize;
782 priv->child2_resize = new_value;
785 case CHILD_PROP_SHRINK:
786 if (child == priv->child1)
788 old_value = priv->child1_shrink;
789 priv->child1_shrink = new_value;
793 old_value = priv->child2_shrink;
794 priv->child2_shrink = new_value;
798 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
799 old_value = -1; /* quiet gcc */
802 if (old_value != new_value)
803 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (container));
807 gtk_paned_get_child_property (GtkContainer *container,
813 GtkPaned *paned = GTK_PANED (container);
814 GtkPanedPrivate *priv = paned->priv;
816 g_assert (child == priv->child1 || child == priv->child2);
820 case CHILD_PROP_RESIZE:
821 if (child == priv->child1)
822 g_value_set_boolean (value, priv->child1_resize);
824 g_value_set_boolean (value, priv->child2_resize);
826 case CHILD_PROP_SHRINK:
827 if (child == priv->child1)
828 g_value_set_boolean (value, priv->child1_shrink);
830 g_value_set_boolean (value, priv->child2_shrink);
833 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
839 gtk_paned_finalize (GObject *object)
841 GtkPaned *paned = GTK_PANED (object);
843 gtk_paned_set_saved_focus (paned, NULL);
844 gtk_paned_set_first_paned (paned, NULL);
846 G_OBJECT_CLASS (gtk_paned_parent_class)->finalize (object);
850 gtk_paned_get_preferred_size (GtkWidget *widget,
851 GtkOrientation orientation,
855 GtkPaned *paned = GTK_PANED (widget);
856 GtkPanedPrivate *priv = paned->priv;
857 gint child_min, child_nat;
859 *minimum = *natural = 0;
861 if (priv->child1 && gtk_widget_get_visible (priv->child1))
863 if (orientation == GTK_ORIENTATION_HORIZONTAL)
864 gtk_widget_get_preferred_width (priv->child1, &child_min, &child_nat);
866 gtk_widget_get_preferred_height (priv->child1, &child_min, &child_nat);
868 *minimum = child_min;
869 *natural = child_nat;
872 if (priv->child2 && gtk_widget_get_visible (priv->child2))
874 if (orientation == GTK_ORIENTATION_HORIZONTAL)
875 gtk_widget_get_preferred_width (priv->child2, &child_min, &child_nat);
877 gtk_widget_get_preferred_height (priv->child2, &child_min, &child_nat);
879 if (priv->orientation == orientation)
881 *minimum += child_min;
882 *natural += child_nat;
886 *minimum = MAX (*minimum, child_min);
887 *natural = MAX (*natural, child_nat);
891 if (priv->child1 && gtk_widget_get_visible (priv->child1) &&
892 priv->child2 && gtk_widget_get_visible (priv->child2))
896 gtk_widget_style_get (widget, "handle-size", &handle_size, NULL);
898 if (priv->orientation == orientation)
900 *minimum += handle_size;
901 *natural += handle_size;
907 gtk_paned_get_preferred_width (GtkWidget *widget,
911 gtk_paned_get_preferred_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum, natural);
915 gtk_paned_get_preferred_height (GtkWidget *widget,
919 gtk_paned_get_preferred_size (widget, GTK_ORIENTATION_VERTICAL, minimum, natural);
923 flip_child (GtkWidget *widget,
924 GtkAllocation *child_pos)
926 GtkAllocation allocation;
929 gtk_widget_get_allocation (widget, &allocation);
931 width = allocation.width;
933 child_pos->x = 2 * x + width - child_pos->x - child_pos->width;
937 gtk_paned_size_allocate (GtkWidget *widget,
938 GtkAllocation *allocation)
940 GtkPaned *paned = GTK_PANED (widget);
941 GtkPanedPrivate *priv = paned->priv;
942 GtkAllocation widget_allocation;
944 gtk_widget_set_allocation (widget, allocation);
946 if (priv->child1 && gtk_widget_get_visible (priv->child1) &&
947 priv->child2 && gtk_widget_get_visible (priv->child2))
949 GtkRequisition child1_requisition;
950 GtkRequisition child2_requisition;
951 GtkAllocation child1_allocation;
952 GtkAllocation child2_allocation;
953 GtkAllocation priv_child1_allocation;
954 GdkRectangle old_handle_pos;
957 gtk_widget_style_get (widget, "handle-size", &handle_size, NULL);
959 gtk_widget_get_preferred_size (priv->child1, &child1_requisition, NULL);
960 gtk_widget_get_preferred_size (priv->child2, &child2_requisition, NULL);
962 old_handle_pos = priv->handle_pos;
964 gtk_widget_get_allocation (widget, &widget_allocation);
966 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
968 gtk_paned_calc_position (paned,
969 MAX (1, widget_allocation.width - handle_size),
970 child1_requisition.width,
971 child2_requisition.width);
973 priv->handle_pos.x = widget_allocation.x + priv->child1_size;
974 priv->handle_pos.y = widget_allocation.y;
975 priv->handle_pos.width = handle_size;
976 priv->handle_pos.height = widget_allocation.height;
978 child1_allocation.height = child2_allocation.height = allocation->height;
979 child1_allocation.width = MAX (1, priv->child1_size);
980 child1_allocation.x = widget_allocation.x;
981 child1_allocation.y = child2_allocation.y = widget_allocation.y;
983 child2_allocation.x = child1_allocation.x + priv->child1_size + priv->handle_pos.width;
984 child2_allocation.width = MAX (1, widget_allocation.x + widget_allocation.width - child2_allocation.x);
986 if (gtk_widget_get_direction (GTK_WIDGET (widget)) == GTK_TEXT_DIR_RTL)
988 flip_child (widget, &(child2_allocation));
989 flip_child (widget, &(child1_allocation));
990 flip_child (widget, &(priv->handle_pos));
995 gtk_paned_calc_position (paned,
996 MAX (1, widget_allocation.height - handle_size),
997 child1_requisition.height,
998 child2_requisition.height);
1000 priv->handle_pos.x = widget_allocation.x;
1001 priv->handle_pos.y = widget_allocation.y + priv->child1_size;
1002 priv->handle_pos.width = widget_allocation.width;
1003 priv->handle_pos.height = handle_size;
1005 child1_allocation.width = child2_allocation.width = allocation->width;
1006 child1_allocation.height = MAX (1, priv->child1_size);
1007 child1_allocation.x = child2_allocation.x = widget_allocation.x;
1008 child1_allocation.y = widget_allocation.y;
1010 child2_allocation.y = child1_allocation.y + priv->child1_size + priv->handle_pos.height;
1011 child2_allocation.height = MAX (1, widget_allocation.y + widget_allocation.height - child2_allocation.y);
1014 if (gtk_widget_get_mapped (widget) &&
1015 (old_handle_pos.x != priv->handle_pos.x ||
1016 old_handle_pos.y != priv->handle_pos.y ||
1017 old_handle_pos.width != priv->handle_pos.width ||
1018 old_handle_pos.height != priv->handle_pos.height))
1022 window = gtk_widget_get_window (widget);
1023 gdk_window_invalidate_rect (window, &old_handle_pos, FALSE);
1024 gdk_window_invalidate_rect (window, &priv->handle_pos, FALSE);
1027 if (gtk_widget_get_realized (widget))
1029 if (gtk_widget_get_mapped (widget))
1030 gdk_window_show (priv->handle);
1032 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1034 gdk_window_move_resize (priv->handle,
1038 priv->handle_pos.height);
1042 gdk_window_move_resize (priv->handle,
1045 priv->handle_pos.width,
1050 /* Now allocate the childen, making sure, when resizing not to
1051 * overlap the windows
1053 gtk_widget_get_allocation (priv->child1, &priv_child1_allocation);
1054 if (gtk_widget_get_mapped (widget) &&
1055 ((priv->orientation == GTK_ORIENTATION_HORIZONTAL &&
1056 priv_child1_allocation.width < child1_allocation.width) ||
1058 (priv->orientation == GTK_ORIENTATION_VERTICAL &&
1059 priv_child1_allocation.height < child1_allocation.height)))
1061 gtk_widget_size_allocate (priv->child2, &child2_allocation);
1062 gtk_widget_size_allocate (priv->child1, &child1_allocation);
1066 gtk_widget_size_allocate (priv->child1, &child1_allocation);
1067 gtk_widget_size_allocate (priv->child2, &child2_allocation);
1072 GtkAllocation child_allocation;
1074 if (gtk_widget_get_realized (widget))
1075 gdk_window_hide (priv->handle);
1078 gtk_widget_set_child_visible (priv->child1, TRUE);
1080 gtk_widget_set_child_visible (priv->child2, TRUE);
1082 gtk_widget_get_allocation (widget, &widget_allocation);
1084 child_allocation.x = widget_allocation.x;
1085 child_allocation.y = widget_allocation.y;
1086 child_allocation.width = allocation->width;
1087 child_allocation.height = allocation->height;
1089 if (priv->child1 && gtk_widget_get_visible (priv->child1))
1090 gtk_widget_size_allocate (priv->child1, &child_allocation);
1091 else if (priv->child2 && gtk_widget_get_visible (priv->child2))
1092 gtk_widget_size_allocate (priv->child2, &child_allocation);
1097 gtk_paned_realize (GtkWidget *widget)
1099 GtkPaned *paned = GTK_PANED (widget);
1100 GtkPanedPrivate *priv = paned->priv;
1102 GdkWindowAttr attributes;
1103 gint attributes_mask;
1105 gtk_widget_set_realized (widget, TRUE);
1107 window = gtk_widget_get_parent_window (widget);
1108 gtk_widget_set_window (widget, window);
1109 g_object_ref (window);
1111 attributes.window_type = GDK_WINDOW_CHILD;
1112 attributes.wclass = GDK_INPUT_ONLY;
1113 attributes.x = priv->handle_pos.x;
1114 attributes.y = priv->handle_pos.y;
1115 attributes.width = priv->handle_pos.width;
1116 attributes.height = priv->handle_pos.height;
1117 attributes.event_mask = gtk_widget_get_events (widget);
1118 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
1119 GDK_BUTTON_RELEASE_MASK |
1120 GDK_ENTER_NOTIFY_MASK |
1121 GDK_LEAVE_NOTIFY_MASK |
1122 GDK_POINTER_MOTION_MASK |
1123 GDK_POINTER_MOTION_HINT_MASK);
1124 attributes_mask = GDK_WA_X | GDK_WA_Y;
1125 if (gtk_widget_is_sensitive (widget))
1127 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
1129 attributes_mask |= GDK_WA_CURSOR;
1132 priv->handle = gdk_window_new (window,
1133 &attributes, attributes_mask);
1134 gdk_window_set_user_data (priv->handle, paned);
1135 if (attributes_mask & GDK_WA_CURSOR)
1136 g_object_unref (attributes.cursor);
1138 if (priv->child1 && gtk_widget_get_visible (priv->child1) &&
1139 priv->child2 && gtk_widget_get_visible (priv->child2))
1140 gdk_window_show (priv->handle);
1144 gtk_paned_unrealize (GtkWidget *widget)
1146 GtkPaned *paned = GTK_PANED (widget);
1147 GtkPanedPrivate *priv = paned->priv;
1151 gdk_window_set_user_data (priv->handle, NULL);
1152 gdk_window_destroy (priv->handle);
1153 priv->handle = NULL;
1156 gtk_paned_set_last_child1_focus (paned, NULL);
1157 gtk_paned_set_last_child2_focus (paned, NULL);
1158 gtk_paned_set_saved_focus (paned, NULL);
1159 gtk_paned_set_first_paned (paned, NULL);
1161 GTK_WIDGET_CLASS (gtk_paned_parent_class)->unrealize (widget);
1165 gtk_paned_map (GtkWidget *widget)
1167 GtkPaned *paned = GTK_PANED (widget);
1168 GtkPanedPrivate *priv = paned->priv;
1170 gdk_window_show (priv->handle);
1172 GTK_WIDGET_CLASS (gtk_paned_parent_class)->map (widget);
1176 gtk_paned_unmap (GtkWidget *widget)
1178 GtkPaned *paned = GTK_PANED (widget);
1179 GtkPanedPrivate *priv = paned->priv;
1181 gdk_window_hide (priv->handle);
1183 GTK_WIDGET_CLASS (gtk_paned_parent_class)->unmap (widget);
1187 gtk_paned_draw (GtkWidget *widget,
1190 GtkPaned *paned = GTK_PANED (widget);
1191 GtkPanedPrivate *priv = paned->priv;
1193 if (gtk_widget_get_visible (widget) && gtk_widget_get_mapped (widget) &&
1194 priv->child1 && gtk_widget_get_visible (priv->child1) &&
1195 priv->child2 && gtk_widget_get_visible (priv->child2))
1197 GtkStyleContext *context;
1198 GtkStateFlags state;
1199 GtkAllocation allocation;
1201 gtk_widget_get_allocation (widget, &allocation);
1202 context = gtk_widget_get_style_context (widget);
1203 state = gtk_widget_get_state_flags (widget);
1205 if (gtk_widget_is_focus (widget))
1206 state |= GTK_STATE_FLAG_SELECTED;
1207 if (priv->handle_prelit)
1208 state |= GTK_STATE_FLAG_PRELIGHT;
1210 gtk_style_context_save (context);
1211 gtk_style_context_set_state (context, state);
1212 gtk_style_context_add_class (context, GTK_STYLE_CLASS_PANE_SEPARATOR);
1213 gtk_render_handle (context, cr,
1214 priv->handle_pos.x - allocation.x,
1215 priv->handle_pos.y - allocation.y,
1216 priv->handle_pos.width,
1217 priv->handle_pos.height);
1219 gtk_style_context_restore (context);
1222 /* Chain up to draw children */
1223 GTK_WIDGET_CLASS (gtk_paned_parent_class)->draw (widget, cr);
1229 is_rtl (GtkPaned *paned)
1231 GtkPanedPrivate *priv = paned->priv;
1233 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL &&
1234 gtk_widget_get_direction (GTK_WIDGET (paned)) == GTK_TEXT_DIR_RTL)
1243 update_drag (GtkPaned *paned)
1245 GtkPanedPrivate *priv = paned->priv;
1246 GtkAllocation allocation;
1247 GtkWidget *widget = GTK_WIDGET (paned);
1252 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1253 gtk_widget_get_pointer (widget, &pos, NULL);
1255 gtk_widget_get_pointer (widget, NULL, &pos);
1257 pos -= priv->drag_pos;
1261 gtk_widget_style_get (widget,
1262 "handle-size", &handle_size,
1265 gtk_widget_get_allocation (widget, &allocation);
1266 size = allocation.width - pos - handle_size;
1273 size = CLAMP (size, priv->min_position, priv->max_position);
1275 if (size != priv->child1_size)
1276 gtk_paned_set_position (paned, size);
1280 gtk_paned_enter (GtkWidget *widget,
1281 GdkEventCrossing *event)
1283 GtkPaned *paned = GTK_PANED (widget);
1284 GtkPanedPrivate *priv = paned->priv;
1287 update_drag (paned);
1290 priv->handle_prelit = TRUE;
1291 gtk_widget_queue_draw_area (widget,
1294 priv->handle_pos.width,
1295 priv->handle_pos.height);
1302 gtk_paned_leave (GtkWidget *widget,
1303 GdkEventCrossing *event)
1305 GtkPaned *paned = GTK_PANED (widget);
1306 GtkPanedPrivate *priv = paned->priv;
1309 update_drag (paned);
1312 priv->handle_prelit = FALSE;
1313 gtk_widget_queue_draw_area (widget,
1316 priv->handle_pos.width,
1317 priv->handle_pos.height);
1324 gtk_paned_focus (GtkWidget *widget,
1325 GtkDirectionType direction)
1330 /* This is a hack, but how can this be done without
1331 * excessive cut-and-paste from gtkcontainer.c?
1334 gtk_widget_set_can_focus (widget, FALSE);
1335 retval = GTK_WIDGET_CLASS (gtk_paned_parent_class)->focus (widget, direction);
1336 gtk_widget_set_can_focus (widget, TRUE);
1342 gtk_paned_button_press (GtkWidget *widget,
1343 GdkEventButton *event)
1345 GtkPaned *paned = GTK_PANED (widget);
1346 GtkPanedPrivate *priv = paned->priv;
1348 if (!priv->in_drag &&
1349 (event->window == priv->handle) && (event->button == 1))
1351 /* We need a server grab here, not gtk_grab_add(), since
1352 * we don't want to pass events on to the widget's children */
1353 if (gdk_device_grab (event->device,
1355 GDK_OWNERSHIP_WINDOW, FALSE,
1356 GDK_POINTER_MOTION_HINT_MASK
1357 | GDK_BUTTON1_MOTION_MASK
1358 | GDK_BUTTON_RELEASE_MASK
1359 | GDK_ENTER_NOTIFY_MASK
1360 | GDK_LEAVE_NOTIFY_MASK,
1361 NULL, event->time) != GDK_GRAB_SUCCESS)
1364 priv->in_drag = TRUE;
1365 priv->grab_time = event->time;
1366 priv->grab_device = event->device;
1368 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1369 priv->drag_pos = event->x;
1371 priv->drag_pos = event->y;
1380 gtk_paned_grab_broken (GtkWidget *widget,
1381 GdkEventGrabBroken *event)
1383 GtkPaned *paned = GTK_PANED (widget);
1384 GtkPanedPrivate *priv = paned->priv;
1386 priv->in_drag = FALSE;
1387 priv->drag_pos = -1;
1388 priv->position_set = TRUE;
1394 stop_drag (GtkPaned *paned)
1396 GtkPanedPrivate *priv = paned->priv;
1398 priv->in_drag = FALSE;
1399 priv->drag_pos = -1;
1400 priv->position_set = TRUE;
1402 gdk_device_ungrab (priv->grab_device,
1404 priv->grab_device = NULL;
1408 gtk_paned_grab_notify (GtkWidget *widget,
1409 gboolean was_grabbed)
1411 GtkPaned *paned = GTK_PANED (widget);
1412 GtkPanedPrivate *priv = paned->priv;
1413 GdkDevice *grab_device;
1415 grab_device = priv->grab_device;
1417 if (priv->in_drag && grab_device &&
1418 gtk_widget_device_is_shadowed (widget, grab_device))
1423 gtk_paned_state_flags_changed (GtkWidget *widget,
1424 GtkStateFlags previous_state)
1426 GtkPaned *paned = GTK_PANED (widget);
1427 GtkPanedPrivate *priv = paned->priv;
1430 if (gtk_widget_get_realized (widget))
1432 if (gtk_widget_is_sensitive (widget))
1433 cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
1438 gdk_window_set_cursor (priv->handle, cursor);
1441 g_object_unref (cursor);
1446 gtk_paned_button_release (GtkWidget *widget,
1447 GdkEventButton *event)
1449 GtkPaned *paned = GTK_PANED (widget);
1450 GtkPanedPrivate *priv = paned->priv;
1452 if (priv->in_drag && (event->button == 1))
1463 gtk_paned_motion (GtkWidget *widget,
1464 GdkEventMotion *event)
1466 GtkPaned *paned = GTK_PANED (widget);
1467 GtkPanedPrivate *priv = paned->priv;
1471 update_drag (paned);
1480 * @orientation: the paned's orientation.
1482 * Creates a new #GtkPaned widget.
1484 * Return value: a new #GtkPaned.
1489 gtk_paned_new (GtkOrientation orientation)
1491 return g_object_new (GTK_TYPE_PANED,
1492 "orientation", orientation,
1498 * @paned: a paned widget
1499 * @child: the child to add
1501 * Adds a child to the top or left pane with default parameters. This is
1503 * <literal>gtk_paned_pack1 (paned, child, FALSE, TRUE)</literal>.
1506 gtk_paned_add1 (GtkPaned *paned,
1509 gtk_paned_pack1 (paned, widget, FALSE, TRUE);
1514 * @paned: a paned widget
1515 * @child: the child to add
1517 * Adds a child to the bottom or right pane with default parameters. This
1519 * <literal>gtk_paned_pack2 (paned, child, TRUE, TRUE)</literal>.
1522 gtk_paned_add2 (GtkPaned *paned,
1525 gtk_paned_pack2 (paned, widget, TRUE, TRUE);
1530 * @paned: a paned widget
1531 * @child: the child to add
1532 * @resize: should this child expand when the paned widget is resized.
1533 * @shrink: can this child be made smaller than its requisition.
1535 * Adds a child to the top or left pane.
1538 gtk_paned_pack1 (GtkPaned *paned,
1543 GtkPanedPrivate *priv;
1545 g_return_if_fail (GTK_IS_PANED (paned));
1546 g_return_if_fail (GTK_IS_WIDGET (child));
1552 priv->child1 = child;
1553 priv->child1_resize = resize;
1554 priv->child1_shrink = shrink;
1556 gtk_widget_set_parent (child, GTK_WIDGET (paned));
1562 * @paned: a paned widget
1563 * @child: the child to add
1564 * @resize: should this child expand when the paned widget is resized.
1565 * @shrink: can this child be made smaller than its requisition.
1567 * Adds a child to the bottom or right pane.
1570 gtk_paned_pack2 (GtkPaned *paned,
1575 GtkPanedPrivate *priv;
1577 g_return_if_fail (GTK_IS_PANED (paned));
1578 g_return_if_fail (GTK_IS_WIDGET (child));
1584 priv->child2 = child;
1585 priv->child2_resize = resize;
1586 priv->child2_shrink = shrink;
1588 gtk_widget_set_parent (child, GTK_WIDGET (paned));
1594 gtk_paned_add (GtkContainer *container,
1597 GtkPanedPrivate *priv;
1600 g_return_if_fail (GTK_IS_PANED (container));
1602 paned = GTK_PANED (container);
1606 gtk_paned_add1 (paned, widget);
1607 else if (!priv->child2)
1608 gtk_paned_add2 (paned, widget);
1610 g_warning ("GtkPaned cannot have more than 2 children\n");
1614 gtk_paned_remove (GtkContainer *container,
1617 GtkPaned *paned = GTK_PANED (container);
1618 GtkPanedPrivate *priv = paned->priv;
1619 gboolean was_visible;
1621 was_visible = gtk_widget_get_visible (widget);
1623 if (priv->child1 == widget)
1625 gtk_widget_unparent (widget);
1627 priv->child1 = NULL;
1629 if (was_visible && gtk_widget_get_visible (GTK_WIDGET (container)))
1630 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (container));
1632 else if (priv->child2 == widget)
1634 gtk_widget_unparent (widget);
1636 priv->child2 = NULL;
1638 if (was_visible && gtk_widget_get_visible (GTK_WIDGET (container)))
1639 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (container));
1644 gtk_paned_forall (GtkContainer *container,
1645 gboolean include_internals,
1646 GtkCallback callback,
1647 gpointer callback_data)
1649 GtkPanedPrivate *priv;
1652 g_return_if_fail (callback != NULL);
1654 paned = GTK_PANED (container);
1658 (*callback) (priv->child1, callback_data);
1660 (*callback) (priv->child2, callback_data);
1664 * gtk_paned_get_position:
1665 * @paned: a #GtkPaned widget
1667 * Obtains the position of the divider between the two panes.
1669 * Return value: position of the divider
1672 gtk_paned_get_position (GtkPaned *paned)
1674 g_return_val_if_fail (GTK_IS_PANED (paned), 0);
1676 return paned->priv->child1_size;
1680 * gtk_paned_set_position:
1681 * @paned: a #GtkPaned widget
1682 * @position: pixel position of divider, a negative value means that the position
1685 * Sets the position of the divider between the two panes.
1688 gtk_paned_set_position (GtkPaned *paned,
1691 GtkPanedPrivate *priv;
1694 g_return_if_fail (GTK_IS_PANED (paned));
1698 if (priv->child1_size == position)
1701 object = G_OBJECT (paned);
1705 /* We don't clamp here - the assumption is that
1706 * if the total allocation changes at the same time
1707 * as the position, the position set is with reference
1708 * to the new total size. If only the position changes,
1709 * then clamping will occur in gtk_paned_calc_position()
1712 priv->child1_size = position;
1713 priv->position_set = TRUE;
1717 priv->position_set = FALSE;
1720 g_object_freeze_notify (object);
1721 g_object_notify (object, "position");
1722 g_object_notify (object, "position-set");
1723 g_object_thaw_notify (object);
1725 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (paned));
1728 /* Hacky work-around for bug #144269 */
1729 if (priv->child2 != NULL)
1731 gtk_widget_queue_draw (priv->child2);
1737 * gtk_paned_get_child1:
1738 * @paned: a #GtkPaned widget
1740 * Obtains the first child of the paned widget.
1742 * Return value: (transfer none): first child, or %NULL if it is not set.
1747 gtk_paned_get_child1 (GtkPaned *paned)
1749 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
1751 return paned->priv->child1;
1755 * gtk_paned_get_child2:
1756 * @paned: a #GtkPaned widget
1758 * Obtains the second child of the paned widget.
1760 * Return value: (transfer none): second child, or %NULL if it is not set.
1765 gtk_paned_get_child2 (GtkPaned *paned)
1767 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
1769 return paned->priv->child2;
1773 gtk_paned_calc_position (GtkPaned *paned,
1778 GtkPanedPrivate *priv = paned->priv;
1780 gint old_min_position;
1781 gint old_max_position;
1783 old_position = priv->child1_size;
1784 old_min_position = priv->min_position;
1785 old_max_position = priv->max_position;
1787 priv->min_position = priv->child1_shrink ? 0 : child1_req;
1789 priv->max_position = allocation;
1790 if (!priv->child2_shrink)
1791 priv->max_position = MAX (1, priv->max_position - child2_req);
1792 priv->max_position = MAX (priv->min_position, priv->max_position);
1794 if (!priv->position_set)
1796 if (priv->child1_resize && !priv->child2_resize)
1797 priv->child1_size = MAX (0, allocation - child2_req);
1798 else if (!priv->child1_resize && priv->child2_resize)
1799 priv->child1_size = child1_req;
1800 else if (child1_req + child2_req != 0)
1801 priv->child1_size = allocation * ((gdouble)child1_req / (child1_req + child2_req)) + 0.5;
1803 priv->child1_size = allocation * 0.5 + 0.5;
1807 /* If the position was set before the initial allocation.
1808 * (priv->last_allocation <= 0) just clamp it and leave it.
1810 if (priv->last_allocation > 0)
1812 if (priv->child1_resize && !priv->child2_resize)
1813 priv->child1_size += allocation - priv->last_allocation;
1814 else if (!(!priv->child1_resize && priv->child2_resize))
1815 priv->child1_size = allocation * ((gdouble) priv->child1_size / (priv->last_allocation)) + 0.5;
1819 priv->child1_size = CLAMP (priv->child1_size,
1821 priv->max_position);
1824 gtk_widget_set_child_visible (priv->child1, priv->child1_size != 0);
1827 gtk_widget_set_child_visible (priv->child2, priv->child1_size != allocation);
1829 g_object_freeze_notify (G_OBJECT (paned));
1830 if (priv->child1_size != old_position)
1831 g_object_notify (G_OBJECT (paned), "position");
1832 if (priv->min_position != old_min_position)
1833 g_object_notify (G_OBJECT (paned), "min-position");
1834 if (priv->max_position != old_max_position)
1835 g_object_notify (G_OBJECT (paned), "max-position");
1836 g_object_thaw_notify (G_OBJECT (paned));
1838 priv->last_allocation = allocation;
1842 gtk_paned_set_saved_focus (GtkPaned *paned, GtkWidget *widget)
1844 GtkPanedPrivate *priv = paned->priv;
1846 if (priv->saved_focus)
1847 g_object_remove_weak_pointer (G_OBJECT (priv->saved_focus),
1848 (gpointer *)&(priv->saved_focus));
1850 priv->saved_focus = widget;
1852 if (priv->saved_focus)
1853 g_object_add_weak_pointer (G_OBJECT (priv->saved_focus),
1854 (gpointer *)&(priv->saved_focus));
1858 gtk_paned_set_first_paned (GtkPaned *paned, GtkPaned *first_paned)
1860 GtkPanedPrivate *priv = paned->priv;
1862 if (priv->first_paned)
1863 g_object_remove_weak_pointer (G_OBJECT (priv->first_paned),
1864 (gpointer *)&(priv->first_paned));
1866 priv->first_paned = first_paned;
1868 if (priv->first_paned)
1869 g_object_add_weak_pointer (G_OBJECT (priv->first_paned),
1870 (gpointer *)&(priv->first_paned));
1874 gtk_paned_set_last_child1_focus (GtkPaned *paned, GtkWidget *widget)
1876 GtkPanedPrivate *priv = paned->priv;
1878 if (priv->last_child1_focus)
1879 g_object_remove_weak_pointer (G_OBJECT (priv->last_child1_focus),
1880 (gpointer *)&(priv->last_child1_focus));
1882 priv->last_child1_focus = widget;
1884 if (priv->last_child1_focus)
1885 g_object_add_weak_pointer (G_OBJECT (priv->last_child1_focus),
1886 (gpointer *)&(priv->last_child1_focus));
1890 gtk_paned_set_last_child2_focus (GtkPaned *paned, GtkWidget *widget)
1892 GtkPanedPrivate *priv = paned->priv;
1894 if (priv->last_child2_focus)
1895 g_object_remove_weak_pointer (G_OBJECT (priv->last_child2_focus),
1896 (gpointer *)&(priv->last_child2_focus));
1898 priv->last_child2_focus = widget;
1900 if (priv->last_child2_focus)
1901 g_object_add_weak_pointer (G_OBJECT (priv->last_child2_focus),
1902 (gpointer *)&(priv->last_child2_focus));
1906 paned_get_focus_widget (GtkPaned *paned)
1908 GtkWidget *toplevel;
1910 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1911 if (gtk_widget_is_toplevel (toplevel))
1912 return gtk_window_get_focus (GTK_WINDOW (toplevel));
1918 gtk_paned_set_focus_child (GtkContainer *container,
1919 GtkWidget *focus_child)
1922 GtkPanedPrivate *priv;
1923 GtkWidget *container_focus_child;
1925 g_return_if_fail (GTK_IS_PANED (container));
1927 paned = GTK_PANED (container);
1930 if (focus_child == NULL)
1932 GtkWidget *last_focus;
1935 last_focus = paned_get_focus_widget (paned);
1939 /* If there is one or more paned widgets between us and the
1940 * focus widget, we want the topmost of those as last_focus
1942 for (w = last_focus; w != GTK_WIDGET (paned); w = gtk_widget_get_parent (w))
1943 if (GTK_IS_PANED (w))
1946 container_focus_child = gtk_container_get_focus_child (container);
1947 if (container_focus_child == priv->child1)
1948 gtk_paned_set_last_child1_focus (paned, last_focus);
1949 else if (container_focus_child == priv->child2)
1950 gtk_paned_set_last_child2_focus (paned, last_focus);
1954 if (GTK_CONTAINER_CLASS (gtk_paned_parent_class)->set_focus_child)
1955 GTK_CONTAINER_CLASS (gtk_paned_parent_class)->set_focus_child (container, focus_child);
1959 gtk_paned_get_cycle_chain (GtkPaned *paned,
1960 GtkDirectionType direction,
1963 GtkPanedPrivate *priv = paned->priv;
1964 GtkContainer *container = GTK_CONTAINER (paned);
1965 GtkWidget *ancestor = NULL;
1966 GtkWidget *focus_child;
1968 GtkWidget *widget = GTK_WIDGET (paned);
1969 GList *temp_list = NULL;
1972 if (priv->in_recursion)
1975 g_assert (widgets != NULL);
1977 if (priv->last_child1_focus &&
1978 !gtk_widget_is_ancestor (priv->last_child1_focus, widget))
1980 gtk_paned_set_last_child1_focus (paned, NULL);
1983 if (priv->last_child2_focus &&
1984 !gtk_widget_is_ancestor (priv->last_child2_focus, widget))
1986 gtk_paned_set_last_child2_focus (paned, NULL);
1989 parent = gtk_widget_get_parent (widget);
1991 ancestor = gtk_widget_get_ancestor (parent, GTK_TYPE_PANED);
1993 /* The idea here is that temp_list is a list of widgets we want to cycle
1994 * to. The list is prioritized so that the first element is our first
1995 * choice, the next our second, and so on.
1997 * We can't just use g_list_reverse(), because we want to try
1998 * priv->last_child?_focus before priv->child?, both when we
1999 * are going forward and backward.
2001 focus_child = gtk_container_get_focus_child (container);
2002 if (direction == GTK_DIR_TAB_FORWARD)
2004 if (focus_child == priv->child1)
2006 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2007 temp_list = g_list_append (temp_list, priv->child2);
2008 temp_list = g_list_append (temp_list, ancestor);
2010 else if (focus_child == priv->child2)
2012 temp_list = g_list_append (temp_list, ancestor);
2013 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2014 temp_list = g_list_append (temp_list, priv->child1);
2018 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2019 temp_list = g_list_append (temp_list, priv->child1);
2020 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2021 temp_list = g_list_append (temp_list, priv->child2);
2022 temp_list = g_list_append (temp_list, ancestor);
2027 if (focus_child == priv->child1)
2029 temp_list = g_list_append (temp_list, ancestor);
2030 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2031 temp_list = g_list_append (temp_list, priv->child2);
2033 else if (focus_child == priv->child2)
2035 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2036 temp_list = g_list_append (temp_list, priv->child1);
2037 temp_list = g_list_append (temp_list, ancestor);
2041 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2042 temp_list = g_list_append (temp_list, priv->child2);
2043 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2044 temp_list = g_list_append (temp_list, priv->child1);
2045 temp_list = g_list_append (temp_list, ancestor);
2049 /* Walk the list and expand all the paned widgets. */
2050 for (list = temp_list; list != NULL; list = list->next)
2052 GtkWidget *widget = list->data;
2056 if (GTK_IS_PANED (widget))
2058 priv->in_recursion = TRUE;
2059 gtk_paned_get_cycle_chain (GTK_PANED (widget), direction, widgets);
2060 priv->in_recursion = FALSE;
2064 *widgets = g_list_append (*widgets, widget);
2069 g_list_free (temp_list);
2073 gtk_paned_cycle_child_focus (GtkPaned *paned,
2076 GList *cycle_chain = NULL;
2079 GtkDirectionType direction = reversed? GTK_DIR_TAB_BACKWARD : GTK_DIR_TAB_FORWARD;
2081 /* ignore f6 if the handle is focused */
2082 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2085 /* we can't just let the event propagate up the hierarchy,
2086 * because the paned will want to cycle focus _unless_ an
2087 * ancestor paned handles the event
2089 gtk_paned_get_cycle_chain (paned, direction, &cycle_chain);
2091 for (list = cycle_chain; list != NULL; list = list->next)
2092 if (gtk_widget_child_focus (GTK_WIDGET (list->data), direction))
2095 g_list_free (cycle_chain);
2101 get_child_panes (GtkWidget *widget,
2104 if (!widget || !gtk_widget_get_realized (widget))
2107 if (GTK_IS_PANED (widget))
2109 GtkPaned *paned = GTK_PANED (widget);
2110 GtkPanedPrivate *priv = paned->priv;
2112 get_child_panes (priv->child1, panes);
2113 *panes = g_list_prepend (*panes, widget);
2114 get_child_panes (priv->child2, panes);
2116 else if (GTK_IS_CONTAINER (widget))
2118 gtk_container_forall (GTK_CONTAINER (widget),
2119 (GtkCallback)get_child_panes, panes);
2124 get_all_panes (GtkPaned *paned)
2126 GtkPaned *topmost = NULL;
2127 GList *result = NULL;
2130 for (w = GTK_WIDGET (paned); w != NULL; w = gtk_widget_get_parent (w))
2132 if (GTK_IS_PANED (w))
2133 topmost = GTK_PANED (w);
2138 get_child_panes (GTK_WIDGET (topmost), &result);
2140 return g_list_reverse (result);
2144 gtk_paned_find_neighbours (GtkPaned *paned,
2151 all_panes = get_all_panes (paned);
2152 g_assert (all_panes);
2154 this_link = g_list_find (all_panes, paned);
2156 g_assert (this_link);
2158 if (this_link->next)
2159 *next = this_link->next->data;
2161 *next = all_panes->data;
2163 if (this_link->prev)
2164 *prev = this_link->prev->data;
2166 *prev = g_list_last (all_panes)->data;
2168 g_list_free (all_panes);
2172 gtk_paned_move_handle (GtkPaned *paned,
2173 GtkScrollType scroll)
2175 GtkPanedPrivate *priv = paned->priv;
2177 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2184 SINGLE_STEP_SIZE = 1,
2188 new_position = old_position = gtk_paned_get_position (paned);
2193 case GTK_SCROLL_STEP_LEFT:
2194 case GTK_SCROLL_STEP_UP:
2195 case GTK_SCROLL_STEP_BACKWARD:
2196 increment = - SINGLE_STEP_SIZE;
2199 case GTK_SCROLL_STEP_RIGHT:
2200 case GTK_SCROLL_STEP_DOWN:
2201 case GTK_SCROLL_STEP_FORWARD:
2202 increment = SINGLE_STEP_SIZE;
2205 case GTK_SCROLL_PAGE_LEFT:
2206 case GTK_SCROLL_PAGE_UP:
2207 case GTK_SCROLL_PAGE_BACKWARD:
2208 increment = - PAGE_STEP_SIZE;
2211 case GTK_SCROLL_PAGE_RIGHT:
2212 case GTK_SCROLL_PAGE_DOWN:
2213 case GTK_SCROLL_PAGE_FORWARD:
2214 increment = PAGE_STEP_SIZE;
2217 case GTK_SCROLL_START:
2218 new_position = priv->min_position;
2221 case GTK_SCROLL_END:
2222 new_position = priv->max_position;
2232 increment = -increment;
2234 new_position = old_position + increment;
2237 new_position = CLAMP (new_position, priv->min_position, priv->max_position);
2239 if (old_position != new_position)
2240 gtk_paned_set_position (paned, new_position);
2249 gtk_paned_restore_focus (GtkPaned *paned)
2251 GtkPanedPrivate *priv = paned->priv;
2253 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2255 if (priv->saved_focus &&
2256 gtk_widget_get_sensitive (priv->saved_focus))
2258 gtk_widget_grab_focus (priv->saved_focus);
2262 /* the saved focus is somehow not available for focusing,
2264 * 1) tabbing into the paned widget
2265 * if that didn't work,
2266 * 2) unset focus for the window if there is one
2269 if (!gtk_widget_child_focus (GTK_WIDGET (paned), GTK_DIR_TAB_FORWARD))
2271 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
2273 if (GTK_IS_WINDOW (toplevel))
2274 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
2278 gtk_paned_set_saved_focus (paned, NULL);
2279 gtk_paned_set_first_paned (paned, NULL);
2284 gtk_paned_accept_position (GtkPaned *paned)
2286 GtkPanedPrivate *priv = paned->priv;
2288 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2290 priv->original_position = -1;
2291 gtk_paned_restore_focus (paned);
2301 gtk_paned_cancel_position (GtkPaned *paned)
2303 GtkPanedPrivate *priv = paned->priv;
2305 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2307 if (priv->original_position != -1)
2309 gtk_paned_set_position (paned, priv->original_position);
2310 priv->original_position = -1;
2313 gtk_paned_restore_focus (paned);
2321 gtk_paned_cycle_handle_focus (GtkPaned *paned,
2324 GtkPanedPrivate *priv = paned->priv;
2325 GtkPaned *next, *prev;
2327 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2329 GtkPaned *focus = NULL;
2331 if (!priv->first_paned)
2333 /* The first_pane has disappeared. As an ad-hoc solution,
2334 * we make the currently focused paned the first_paned. To the
2335 * user this will seem like the paned cycling has been reset.
2338 gtk_paned_set_first_paned (paned, paned);
2341 gtk_paned_find_neighbours (paned, &next, &prev);
2343 if (reversed && prev &&
2344 prev != paned && paned != priv->first_paned)
2348 else if (!reversed && next &&
2349 next != paned && next != priv->first_paned)
2355 gtk_paned_accept_position (paned);
2361 gtk_paned_set_saved_focus (focus, priv->saved_focus);
2362 gtk_paned_set_first_paned (focus, priv->first_paned);
2364 gtk_paned_set_saved_focus (paned, NULL);
2365 gtk_paned_set_first_paned (paned, NULL);
2367 gtk_widget_grab_focus (GTK_WIDGET (focus));
2369 if (!gtk_widget_is_focus (GTK_WIDGET (paned)))
2371 priv->original_position = -1;
2372 focus->priv->original_position = gtk_paned_get_position (focus);
2377 GtkContainer *container = GTK_CONTAINER (paned);
2380 GtkPaned *prev, *next;
2381 GtkWidget *toplevel;
2382 GtkWidget *focus_child;
2384 gtk_paned_find_neighbours (paned, &next, &prev);
2385 focus_child = gtk_container_get_focus_child (container);
2387 if (focus_child == priv->child1)
2400 else if (focus_child == priv->child2)
2415 /* Focus is not inside this paned, and we don't have focus.
2416 * Presumably this happened because the application wants us
2417 * to start keyboard navigating.
2427 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
2429 if (GTK_IS_WINDOW (toplevel))
2430 gtk_paned_set_saved_focus (focus, gtk_window_get_focus (GTK_WINDOW (toplevel)));
2431 gtk_paned_set_first_paned (focus, first);
2432 focus->priv->original_position = gtk_paned_get_position (focus);
2434 gtk_widget_grab_focus (GTK_WIDGET (focus));
2441 gtk_paned_toggle_handle_focus (GtkPaned *paned)
2443 /* This function/signal has the wrong name. It is called when you
2444 * press Tab or Shift-Tab and what we do is act as if
2445 * the user pressed Return and then Tab or Shift-Tab
2447 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2448 gtk_paned_accept_position (paned);
2454 * gtk_paned_get_handle_window:
2455 * @paned: a #GtkPaned
2457 * Returns the #GdkWindow of the handle. This function is
2458 * useful when handling button or motion events because it
2459 * enables the callback to distinguish between the window
2460 * of the paned, a child and the handle.
2462 * Return value: (transfer none): the paned's handle window.
2467 gtk_paned_get_handle_window (GtkPaned *paned)
2469 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
2471 return paned->priv->handle;