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;
651 GtkStyleContext *context;
653 gtk_widget_set_has_window (GTK_WIDGET (paned), FALSE);
654 gtk_widget_set_can_focus (GTK_WIDGET (paned), TRUE);
656 /* We only need to redraw when the handle position moves, which is
657 * independent of the overall allocation of the GtkPaned
659 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (paned), FALSE);
661 paned->priv = G_TYPE_INSTANCE_GET_PRIVATE (paned, GTK_TYPE_PANED, GtkPanedPrivate);
664 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
665 priv->cursor_type = GDK_SB_H_DOUBLE_ARROW;
670 priv->cursor_type = GDK_CROSS;
672 priv->handle_pos.width = 5;
673 priv->handle_pos.height = 5;
674 priv->position_set = FALSE;
675 priv->last_allocation = -1;
676 priv->in_drag = FALSE;
678 priv->last_child1_focus = NULL;
679 priv->last_child2_focus = NULL;
680 priv->in_recursion = FALSE;
681 priv->handle_prelit = FALSE;
682 priv->original_position = -1;
684 priv->handle_pos.x = -1;
685 priv->handle_pos.y = -1;
689 context = gtk_widget_get_style_context (GTK_WIDGET (paned));
690 gtk_style_context_add_class (context, GTK_STYLE_CLASS_PANE_SEPARATOR);
694 gtk_paned_set_property (GObject *object,
699 GtkPaned *paned = GTK_PANED (object);
700 GtkPanedPrivate *priv = paned->priv;
704 case PROP_ORIENTATION:
705 priv->orientation = g_value_get_enum (value);
707 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
708 priv->cursor_type = GDK_SB_H_DOUBLE_ARROW;
710 priv->cursor_type = GDK_SB_V_DOUBLE_ARROW;
712 /* state_flags_changed updates the cursor */
713 gtk_paned_state_flags_changed (GTK_WIDGET (paned), 0);
714 gtk_widget_queue_resize (GTK_WIDGET (paned));
717 gtk_paned_set_position (paned, g_value_get_int (value));
719 case PROP_POSITION_SET:
720 priv->position_set = g_value_get_boolean (value);
721 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (paned));
724 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
730 gtk_paned_get_property (GObject *object,
735 GtkPaned *paned = GTK_PANED (object);
736 GtkPanedPrivate *priv = paned->priv;
740 case PROP_ORIENTATION:
741 g_value_set_enum (value, priv->orientation);
744 g_value_set_int (value, priv->child1_size);
746 case PROP_POSITION_SET:
747 g_value_set_boolean (value, priv->position_set);
749 case PROP_MIN_POSITION:
750 g_value_set_int (value, priv->min_position);
752 case PROP_MAX_POSITION:
753 g_value_set_int (value, priv->max_position);
756 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
762 gtk_paned_set_child_property (GtkContainer *container,
768 GtkPaned *paned = GTK_PANED (container);
769 GtkPanedPrivate *priv = paned->priv;
770 gboolean old_value, new_value;
772 g_assert (child == priv->child1 || child == priv->child2);
774 new_value = g_value_get_boolean (value);
777 case CHILD_PROP_RESIZE:
778 if (child == priv->child1)
780 old_value = priv->child1_resize;
781 priv->child1_resize = new_value;
785 old_value = priv->child2_resize;
786 priv->child2_resize = new_value;
789 case CHILD_PROP_SHRINK:
790 if (child == priv->child1)
792 old_value = priv->child1_shrink;
793 priv->child1_shrink = new_value;
797 old_value = priv->child2_shrink;
798 priv->child2_shrink = new_value;
802 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
803 old_value = -1; /* quiet gcc */
806 if (old_value != new_value)
807 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (container));
811 gtk_paned_get_child_property (GtkContainer *container,
817 GtkPaned *paned = GTK_PANED (container);
818 GtkPanedPrivate *priv = paned->priv;
820 g_assert (child == priv->child1 || child == priv->child2);
824 case CHILD_PROP_RESIZE:
825 if (child == priv->child1)
826 g_value_set_boolean (value, priv->child1_resize);
828 g_value_set_boolean (value, priv->child2_resize);
830 case CHILD_PROP_SHRINK:
831 if (child == priv->child1)
832 g_value_set_boolean (value, priv->child1_shrink);
834 g_value_set_boolean (value, priv->child2_shrink);
837 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
843 gtk_paned_finalize (GObject *object)
845 GtkPaned *paned = GTK_PANED (object);
847 gtk_paned_set_saved_focus (paned, NULL);
848 gtk_paned_set_first_paned (paned, NULL);
850 G_OBJECT_CLASS (gtk_paned_parent_class)->finalize (object);
854 gtk_paned_get_preferred_size (GtkWidget *widget,
855 GtkOrientation orientation,
859 GtkPaned *paned = GTK_PANED (widget);
860 GtkPanedPrivate *priv = paned->priv;
861 gint child_min, child_nat;
863 *minimum = *natural = 0;
865 if (priv->child1 && gtk_widget_get_visible (priv->child1))
867 if (orientation == GTK_ORIENTATION_HORIZONTAL)
868 gtk_widget_get_preferred_width (priv->child1, &child_min, &child_nat);
870 gtk_widget_get_preferred_height (priv->child1, &child_min, &child_nat);
872 *minimum = child_min;
873 *natural = child_nat;
876 if (priv->child2 && gtk_widget_get_visible (priv->child2))
878 if (orientation == GTK_ORIENTATION_HORIZONTAL)
879 gtk_widget_get_preferred_width (priv->child2, &child_min, &child_nat);
881 gtk_widget_get_preferred_height (priv->child2, &child_min, &child_nat);
883 if (priv->orientation == orientation)
885 *minimum += child_min;
886 *natural += child_nat;
890 *minimum = MAX (*minimum, child_min);
891 *natural = MAX (*natural, child_nat);
895 if (priv->child1 && gtk_widget_get_visible (priv->child1) &&
896 priv->child2 && gtk_widget_get_visible (priv->child2))
900 gtk_widget_style_get (widget, "handle-size", &handle_size, NULL);
902 if (priv->orientation == orientation)
904 *minimum += handle_size;
905 *natural += handle_size;
911 gtk_paned_get_preferred_width (GtkWidget *widget,
915 gtk_paned_get_preferred_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum, natural);
919 gtk_paned_get_preferred_height (GtkWidget *widget,
923 gtk_paned_get_preferred_size (widget, GTK_ORIENTATION_VERTICAL, minimum, natural);
927 flip_child (GtkWidget *widget,
928 GtkAllocation *child_pos)
930 GtkAllocation allocation;
933 gtk_widget_get_allocation (widget, &allocation);
935 width = allocation.width;
937 child_pos->x = 2 * x + width - child_pos->x - child_pos->width;
941 gtk_paned_size_allocate (GtkWidget *widget,
942 GtkAllocation *allocation)
944 GtkPaned *paned = GTK_PANED (widget);
945 GtkPanedPrivate *priv = paned->priv;
946 GtkAllocation widget_allocation;
948 gtk_widget_set_allocation (widget, allocation);
950 if (priv->child1 && gtk_widget_get_visible (priv->child1) &&
951 priv->child2 && gtk_widget_get_visible (priv->child2))
953 GtkRequisition child1_requisition;
954 GtkRequisition child2_requisition;
955 GtkAllocation child1_allocation;
956 GtkAllocation child2_allocation;
957 GtkAllocation priv_child1_allocation;
958 GdkRectangle old_handle_pos;
961 gtk_widget_style_get (widget, "handle-size", &handle_size, NULL);
963 gtk_widget_get_preferred_size (priv->child1, &child1_requisition, NULL);
964 gtk_widget_get_preferred_size (priv->child2, &child2_requisition, NULL);
966 old_handle_pos = priv->handle_pos;
968 gtk_widget_get_allocation (widget, &widget_allocation);
970 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
972 gtk_paned_calc_position (paned,
973 MAX (1, widget_allocation.width - handle_size),
974 child1_requisition.width,
975 child2_requisition.width);
977 priv->handle_pos.x = widget_allocation.x + priv->child1_size;
978 priv->handle_pos.y = widget_allocation.y;
979 priv->handle_pos.width = handle_size;
980 priv->handle_pos.height = widget_allocation.height;
982 child1_allocation.height = child2_allocation.height = allocation->height;
983 child1_allocation.width = MAX (1, priv->child1_size);
984 child1_allocation.x = widget_allocation.x;
985 child1_allocation.y = child2_allocation.y = widget_allocation.y;
987 child2_allocation.x = child1_allocation.x + priv->child1_size + priv->handle_pos.width;
988 child2_allocation.width = MAX (1, widget_allocation.x + widget_allocation.width - child2_allocation.x);
990 if (gtk_widget_get_direction (GTK_WIDGET (widget)) == GTK_TEXT_DIR_RTL)
992 flip_child (widget, &(child2_allocation));
993 flip_child (widget, &(child1_allocation));
994 flip_child (widget, &(priv->handle_pos));
999 gtk_paned_calc_position (paned,
1000 MAX (1, widget_allocation.height - handle_size),
1001 child1_requisition.height,
1002 child2_requisition.height);
1004 priv->handle_pos.x = widget_allocation.x;
1005 priv->handle_pos.y = widget_allocation.y + priv->child1_size;
1006 priv->handle_pos.width = widget_allocation.width;
1007 priv->handle_pos.height = handle_size;
1009 child1_allocation.width = child2_allocation.width = allocation->width;
1010 child1_allocation.height = MAX (1, priv->child1_size);
1011 child1_allocation.x = child2_allocation.x = widget_allocation.x;
1012 child1_allocation.y = widget_allocation.y;
1014 child2_allocation.y = child1_allocation.y + priv->child1_size + priv->handle_pos.height;
1015 child2_allocation.height = MAX (1, widget_allocation.y + widget_allocation.height - child2_allocation.y);
1018 if (gtk_widget_get_mapped (widget) &&
1019 (old_handle_pos.x != priv->handle_pos.x ||
1020 old_handle_pos.y != priv->handle_pos.y ||
1021 old_handle_pos.width != priv->handle_pos.width ||
1022 old_handle_pos.height != priv->handle_pos.height))
1026 window = gtk_widget_get_window (widget);
1027 gdk_window_invalidate_rect (window, &old_handle_pos, FALSE);
1028 gdk_window_invalidate_rect (window, &priv->handle_pos, FALSE);
1031 if (gtk_widget_get_realized (widget))
1033 if (gtk_widget_get_mapped (widget))
1034 gdk_window_show (priv->handle);
1036 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1038 gdk_window_move_resize (priv->handle,
1042 priv->handle_pos.height);
1046 gdk_window_move_resize (priv->handle,
1049 priv->handle_pos.width,
1054 /* Now allocate the childen, making sure, when resizing not to
1055 * overlap the windows
1057 gtk_widget_get_allocation (priv->child1, &priv_child1_allocation);
1058 if (gtk_widget_get_mapped (widget) &&
1059 ((priv->orientation == GTK_ORIENTATION_HORIZONTAL &&
1060 priv_child1_allocation.width < child1_allocation.width) ||
1062 (priv->orientation == GTK_ORIENTATION_VERTICAL &&
1063 priv_child1_allocation.height < child1_allocation.height)))
1065 gtk_widget_size_allocate (priv->child2, &child2_allocation);
1066 gtk_widget_size_allocate (priv->child1, &child1_allocation);
1070 gtk_widget_size_allocate (priv->child1, &child1_allocation);
1071 gtk_widget_size_allocate (priv->child2, &child2_allocation);
1076 GtkAllocation child_allocation;
1078 if (gtk_widget_get_realized (widget))
1079 gdk_window_hide (priv->handle);
1082 gtk_widget_set_child_visible (priv->child1, TRUE);
1084 gtk_widget_set_child_visible (priv->child2, TRUE);
1086 gtk_widget_get_allocation (widget, &widget_allocation);
1088 child_allocation.x = widget_allocation.x;
1089 child_allocation.y = widget_allocation.y;
1090 child_allocation.width = allocation->width;
1091 child_allocation.height = allocation->height;
1093 if (priv->child1 && gtk_widget_get_visible (priv->child1))
1094 gtk_widget_size_allocate (priv->child1, &child_allocation);
1095 else if (priv->child2 && gtk_widget_get_visible (priv->child2))
1096 gtk_widget_size_allocate (priv->child2, &child_allocation);
1101 gtk_paned_realize (GtkWidget *widget)
1103 GtkPaned *paned = GTK_PANED (widget);
1104 GtkPanedPrivate *priv = paned->priv;
1106 GdkWindowAttr attributes;
1107 gint attributes_mask;
1109 gtk_widget_set_realized (widget, TRUE);
1111 window = gtk_widget_get_parent_window (widget);
1112 gtk_widget_set_window (widget, window);
1113 g_object_ref (window);
1115 attributes.window_type = GDK_WINDOW_CHILD;
1116 attributes.wclass = GDK_INPUT_ONLY;
1117 attributes.x = priv->handle_pos.x;
1118 attributes.y = priv->handle_pos.y;
1119 attributes.width = priv->handle_pos.width;
1120 attributes.height = priv->handle_pos.height;
1121 attributes.event_mask = gtk_widget_get_events (widget);
1122 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
1123 GDK_BUTTON_RELEASE_MASK |
1124 GDK_ENTER_NOTIFY_MASK |
1125 GDK_LEAVE_NOTIFY_MASK |
1126 GDK_POINTER_MOTION_MASK |
1127 GDK_POINTER_MOTION_HINT_MASK);
1128 attributes_mask = GDK_WA_X | GDK_WA_Y;
1129 if (gtk_widget_is_sensitive (widget))
1131 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
1133 attributes_mask |= GDK_WA_CURSOR;
1136 priv->handle = gdk_window_new (window,
1137 &attributes, attributes_mask);
1138 gdk_window_set_user_data (priv->handle, paned);
1139 if (attributes_mask & GDK_WA_CURSOR)
1140 g_object_unref (attributes.cursor);
1142 if (priv->child1 && gtk_widget_get_visible (priv->child1) &&
1143 priv->child2 && gtk_widget_get_visible (priv->child2))
1144 gdk_window_show (priv->handle);
1148 gtk_paned_unrealize (GtkWidget *widget)
1150 GtkPaned *paned = GTK_PANED (widget);
1151 GtkPanedPrivate *priv = paned->priv;
1155 gdk_window_set_user_data (priv->handle, NULL);
1156 gdk_window_destroy (priv->handle);
1157 priv->handle = NULL;
1160 gtk_paned_set_last_child1_focus (paned, NULL);
1161 gtk_paned_set_last_child2_focus (paned, NULL);
1162 gtk_paned_set_saved_focus (paned, NULL);
1163 gtk_paned_set_first_paned (paned, NULL);
1165 GTK_WIDGET_CLASS (gtk_paned_parent_class)->unrealize (widget);
1169 gtk_paned_map (GtkWidget *widget)
1171 GtkPaned *paned = GTK_PANED (widget);
1172 GtkPanedPrivate *priv = paned->priv;
1174 gdk_window_show (priv->handle);
1176 GTK_WIDGET_CLASS (gtk_paned_parent_class)->map (widget);
1180 gtk_paned_unmap (GtkWidget *widget)
1182 GtkPaned *paned = GTK_PANED (widget);
1183 GtkPanedPrivate *priv = paned->priv;
1185 gdk_window_hide (priv->handle);
1187 GTK_WIDGET_CLASS (gtk_paned_parent_class)->unmap (widget);
1191 gtk_paned_draw (GtkWidget *widget,
1194 GtkPaned *paned = GTK_PANED (widget);
1195 GtkPanedPrivate *priv = paned->priv;
1197 if (gtk_widget_get_visible (widget) && gtk_widget_get_mapped (widget) &&
1198 priv->child1 && gtk_widget_get_visible (priv->child1) &&
1199 priv->child2 && gtk_widget_get_visible (priv->child2))
1201 GtkStyleContext *context;
1202 GtkStateFlags state;
1203 GtkAllocation allocation;
1205 gtk_widget_get_allocation (widget, &allocation);
1206 context = gtk_widget_get_style_context (widget);
1207 state = gtk_widget_get_state_flags (widget);
1209 if (gtk_widget_is_focus (widget))
1210 state |= GTK_STATE_FLAG_SELECTED;
1211 if (priv->handle_prelit)
1212 state |= GTK_STATE_FLAG_PRELIGHT;
1214 gtk_style_context_save (context);
1215 gtk_style_context_set_state (context, state);
1216 gtk_render_handle (context, cr,
1217 priv->handle_pos.x - allocation.x,
1218 priv->handle_pos.y - allocation.y,
1219 priv->handle_pos.width,
1220 priv->handle_pos.height);
1222 gtk_style_context_restore (context);
1225 /* Chain up to draw children */
1226 GTK_WIDGET_CLASS (gtk_paned_parent_class)->draw (widget, cr);
1232 is_rtl (GtkPaned *paned)
1234 GtkPanedPrivate *priv = paned->priv;
1236 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL &&
1237 gtk_widget_get_direction (GTK_WIDGET (paned)) == GTK_TEXT_DIR_RTL)
1246 update_drag (GtkPaned *paned)
1248 GtkPanedPrivate *priv = paned->priv;
1249 GtkAllocation allocation;
1250 GtkWidget *widget = GTK_WIDGET (paned);
1255 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1256 gtk_widget_get_pointer (widget, &pos, NULL);
1258 gtk_widget_get_pointer (widget, NULL, &pos);
1260 pos -= priv->drag_pos;
1264 gtk_widget_style_get (widget,
1265 "handle-size", &handle_size,
1268 gtk_widget_get_allocation (widget, &allocation);
1269 size = allocation.width - pos - handle_size;
1276 size = CLAMP (size, priv->min_position, priv->max_position);
1278 if (size != priv->child1_size)
1279 gtk_paned_set_position (paned, size);
1283 gtk_paned_enter (GtkWidget *widget,
1284 GdkEventCrossing *event)
1286 GtkPaned *paned = GTK_PANED (widget);
1287 GtkPanedPrivate *priv = paned->priv;
1290 update_drag (paned);
1293 priv->handle_prelit = TRUE;
1294 gtk_widget_queue_draw_area (widget,
1297 priv->handle_pos.width,
1298 priv->handle_pos.height);
1305 gtk_paned_leave (GtkWidget *widget,
1306 GdkEventCrossing *event)
1308 GtkPaned *paned = GTK_PANED (widget);
1309 GtkPanedPrivate *priv = paned->priv;
1312 update_drag (paned);
1315 priv->handle_prelit = FALSE;
1316 gtk_widget_queue_draw_area (widget,
1319 priv->handle_pos.width,
1320 priv->handle_pos.height);
1327 gtk_paned_focus (GtkWidget *widget,
1328 GtkDirectionType direction)
1333 /* This is a hack, but how can this be done without
1334 * excessive cut-and-paste from gtkcontainer.c?
1337 gtk_widget_set_can_focus (widget, FALSE);
1338 retval = GTK_WIDGET_CLASS (gtk_paned_parent_class)->focus (widget, direction);
1339 gtk_widget_set_can_focus (widget, TRUE);
1345 gtk_paned_button_press (GtkWidget *widget,
1346 GdkEventButton *event)
1348 GtkPaned *paned = GTK_PANED (widget);
1349 GtkPanedPrivate *priv = paned->priv;
1351 if (!priv->in_drag &&
1352 (event->window == priv->handle) && (event->button == 1))
1354 /* We need a server grab here, not gtk_grab_add(), since
1355 * we don't want to pass events on to the widget's children */
1356 if (gdk_device_grab (event->device,
1358 GDK_OWNERSHIP_WINDOW, FALSE,
1359 GDK_POINTER_MOTION_HINT_MASK
1360 | GDK_BUTTON1_MOTION_MASK
1361 | GDK_BUTTON_RELEASE_MASK
1362 | GDK_ENTER_NOTIFY_MASK
1363 | GDK_LEAVE_NOTIFY_MASK,
1364 NULL, event->time) != GDK_GRAB_SUCCESS)
1367 priv->in_drag = TRUE;
1368 priv->grab_time = event->time;
1369 priv->grab_device = event->device;
1371 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1372 priv->drag_pos = event->x;
1374 priv->drag_pos = event->y;
1383 gtk_paned_grab_broken (GtkWidget *widget,
1384 GdkEventGrabBroken *event)
1386 GtkPaned *paned = GTK_PANED (widget);
1387 GtkPanedPrivate *priv = paned->priv;
1389 priv->in_drag = FALSE;
1390 priv->drag_pos = -1;
1391 priv->position_set = TRUE;
1397 stop_drag (GtkPaned *paned)
1399 GtkPanedPrivate *priv = paned->priv;
1401 priv->in_drag = FALSE;
1402 priv->drag_pos = -1;
1403 priv->position_set = TRUE;
1405 gdk_device_ungrab (priv->grab_device,
1407 priv->grab_device = NULL;
1411 gtk_paned_grab_notify (GtkWidget *widget,
1412 gboolean was_grabbed)
1414 GtkPaned *paned = GTK_PANED (widget);
1415 GtkPanedPrivate *priv = paned->priv;
1416 GdkDevice *grab_device;
1418 grab_device = priv->grab_device;
1420 if (priv->in_drag && grab_device &&
1421 gtk_widget_device_is_shadowed (widget, grab_device))
1426 gtk_paned_state_flags_changed (GtkWidget *widget,
1427 GtkStateFlags previous_state)
1429 GtkPaned *paned = GTK_PANED (widget);
1430 GtkPanedPrivate *priv = paned->priv;
1433 if (gtk_widget_get_realized (widget))
1435 if (gtk_widget_is_sensitive (widget))
1436 cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
1441 gdk_window_set_cursor (priv->handle, cursor);
1444 g_object_unref (cursor);
1449 gtk_paned_button_release (GtkWidget *widget,
1450 GdkEventButton *event)
1452 GtkPaned *paned = GTK_PANED (widget);
1453 GtkPanedPrivate *priv = paned->priv;
1455 if (priv->in_drag && (event->button == 1))
1466 gtk_paned_motion (GtkWidget *widget,
1467 GdkEventMotion *event)
1469 GtkPaned *paned = GTK_PANED (widget);
1470 GtkPanedPrivate *priv = paned->priv;
1474 update_drag (paned);
1483 * @orientation: the paned's orientation.
1485 * Creates a new #GtkPaned widget.
1487 * Return value: a new #GtkPaned.
1492 gtk_paned_new (GtkOrientation orientation)
1494 return g_object_new (GTK_TYPE_PANED,
1495 "orientation", orientation,
1501 * @paned: a paned widget
1502 * @child: the child to add
1504 * Adds a child to the top or left pane with default parameters. This is
1506 * <literal>gtk_paned_pack1 (paned, child, FALSE, TRUE)</literal>.
1509 gtk_paned_add1 (GtkPaned *paned,
1512 gtk_paned_pack1 (paned, widget, FALSE, TRUE);
1517 * @paned: a paned widget
1518 * @child: the child to add
1520 * Adds a child to the bottom or right pane with default parameters. This
1522 * <literal>gtk_paned_pack2 (paned, child, TRUE, TRUE)</literal>.
1525 gtk_paned_add2 (GtkPaned *paned,
1528 gtk_paned_pack2 (paned, widget, TRUE, TRUE);
1533 * @paned: a paned widget
1534 * @child: the child to add
1535 * @resize: should this child expand when the paned widget is resized.
1536 * @shrink: can this child be made smaller than its requisition.
1538 * Adds a child to the top or left pane.
1541 gtk_paned_pack1 (GtkPaned *paned,
1546 GtkPanedPrivate *priv;
1548 g_return_if_fail (GTK_IS_PANED (paned));
1549 g_return_if_fail (GTK_IS_WIDGET (child));
1555 priv->child1 = child;
1556 priv->child1_resize = resize;
1557 priv->child1_shrink = shrink;
1559 gtk_widget_set_parent (child, GTK_WIDGET (paned));
1565 * @paned: a paned widget
1566 * @child: the child to add
1567 * @resize: should this child expand when the paned widget is resized.
1568 * @shrink: can this child be made smaller than its requisition.
1570 * Adds a child to the bottom or right pane.
1573 gtk_paned_pack2 (GtkPaned *paned,
1578 GtkPanedPrivate *priv;
1580 g_return_if_fail (GTK_IS_PANED (paned));
1581 g_return_if_fail (GTK_IS_WIDGET (child));
1587 priv->child2 = child;
1588 priv->child2_resize = resize;
1589 priv->child2_shrink = shrink;
1591 gtk_widget_set_parent (child, GTK_WIDGET (paned));
1597 gtk_paned_add (GtkContainer *container,
1600 GtkPanedPrivate *priv;
1603 g_return_if_fail (GTK_IS_PANED (container));
1605 paned = GTK_PANED (container);
1609 gtk_paned_add1 (paned, widget);
1610 else if (!priv->child2)
1611 gtk_paned_add2 (paned, widget);
1613 g_warning ("GtkPaned cannot have more than 2 children\n");
1617 gtk_paned_remove (GtkContainer *container,
1620 GtkPaned *paned = GTK_PANED (container);
1621 GtkPanedPrivate *priv = paned->priv;
1622 gboolean was_visible;
1624 was_visible = gtk_widget_get_visible (widget);
1626 if (priv->child1 == widget)
1628 gtk_widget_unparent (widget);
1630 priv->child1 = NULL;
1632 if (was_visible && gtk_widget_get_visible (GTK_WIDGET (container)))
1633 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (container));
1635 else if (priv->child2 == widget)
1637 gtk_widget_unparent (widget);
1639 priv->child2 = NULL;
1641 if (was_visible && gtk_widget_get_visible (GTK_WIDGET (container)))
1642 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (container));
1647 gtk_paned_forall (GtkContainer *container,
1648 gboolean include_internals,
1649 GtkCallback callback,
1650 gpointer callback_data)
1652 GtkPanedPrivate *priv;
1655 g_return_if_fail (callback != NULL);
1657 paned = GTK_PANED (container);
1661 (*callback) (priv->child1, callback_data);
1663 (*callback) (priv->child2, callback_data);
1667 * gtk_paned_get_position:
1668 * @paned: a #GtkPaned widget
1670 * Obtains the position of the divider between the two panes.
1672 * Return value: position of the divider
1675 gtk_paned_get_position (GtkPaned *paned)
1677 g_return_val_if_fail (GTK_IS_PANED (paned), 0);
1679 return paned->priv->child1_size;
1683 * gtk_paned_set_position:
1684 * @paned: a #GtkPaned widget
1685 * @position: pixel position of divider, a negative value means that the position
1688 * Sets the position of the divider between the two panes.
1691 gtk_paned_set_position (GtkPaned *paned,
1694 GtkPanedPrivate *priv;
1697 g_return_if_fail (GTK_IS_PANED (paned));
1701 if (priv->child1_size == position)
1704 object = G_OBJECT (paned);
1708 /* We don't clamp here - the assumption is that
1709 * if the total allocation changes at the same time
1710 * as the position, the position set is with reference
1711 * to the new total size. If only the position changes,
1712 * then clamping will occur in gtk_paned_calc_position()
1715 priv->child1_size = position;
1716 priv->position_set = TRUE;
1720 priv->position_set = FALSE;
1723 g_object_freeze_notify (object);
1724 g_object_notify (object, "position");
1725 g_object_notify (object, "position-set");
1726 g_object_thaw_notify (object);
1728 gtk_widget_queue_resize_no_redraw (GTK_WIDGET (paned));
1731 /* Hacky work-around for bug #144269 */
1732 if (priv->child2 != NULL)
1734 gtk_widget_queue_draw (priv->child2);
1740 * gtk_paned_get_child1:
1741 * @paned: a #GtkPaned widget
1743 * Obtains the first child of the paned widget.
1745 * Return value: (transfer none): first child, or %NULL if it is not set.
1750 gtk_paned_get_child1 (GtkPaned *paned)
1752 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
1754 return paned->priv->child1;
1758 * gtk_paned_get_child2:
1759 * @paned: a #GtkPaned widget
1761 * Obtains the second child of the paned widget.
1763 * Return value: (transfer none): second child, or %NULL if it is not set.
1768 gtk_paned_get_child2 (GtkPaned *paned)
1770 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
1772 return paned->priv->child2;
1776 gtk_paned_calc_position (GtkPaned *paned,
1781 GtkPanedPrivate *priv = paned->priv;
1783 gint old_min_position;
1784 gint old_max_position;
1786 old_position = priv->child1_size;
1787 old_min_position = priv->min_position;
1788 old_max_position = priv->max_position;
1790 priv->min_position = priv->child1_shrink ? 0 : child1_req;
1792 priv->max_position = allocation;
1793 if (!priv->child2_shrink)
1794 priv->max_position = MAX (1, priv->max_position - child2_req);
1795 priv->max_position = MAX (priv->min_position, priv->max_position);
1797 if (!priv->position_set)
1799 if (priv->child1_resize && !priv->child2_resize)
1800 priv->child1_size = MAX (0, allocation - child2_req);
1801 else if (!priv->child1_resize && priv->child2_resize)
1802 priv->child1_size = child1_req;
1803 else if (child1_req + child2_req != 0)
1804 priv->child1_size = allocation * ((gdouble)child1_req / (child1_req + child2_req)) + 0.5;
1806 priv->child1_size = allocation * 0.5 + 0.5;
1810 /* If the position was set before the initial allocation.
1811 * (priv->last_allocation <= 0) just clamp it and leave it.
1813 if (priv->last_allocation > 0)
1815 if (priv->child1_resize && !priv->child2_resize)
1816 priv->child1_size += allocation - priv->last_allocation;
1817 else if (!(!priv->child1_resize && priv->child2_resize))
1818 priv->child1_size = allocation * ((gdouble) priv->child1_size / (priv->last_allocation)) + 0.5;
1822 priv->child1_size = CLAMP (priv->child1_size,
1824 priv->max_position);
1827 gtk_widget_set_child_visible (priv->child1, priv->child1_size != 0);
1830 gtk_widget_set_child_visible (priv->child2, priv->child1_size != allocation);
1832 g_object_freeze_notify (G_OBJECT (paned));
1833 if (priv->child1_size != old_position)
1834 g_object_notify (G_OBJECT (paned), "position");
1835 if (priv->min_position != old_min_position)
1836 g_object_notify (G_OBJECT (paned), "min-position");
1837 if (priv->max_position != old_max_position)
1838 g_object_notify (G_OBJECT (paned), "max-position");
1839 g_object_thaw_notify (G_OBJECT (paned));
1841 priv->last_allocation = allocation;
1845 gtk_paned_set_saved_focus (GtkPaned *paned, GtkWidget *widget)
1847 GtkPanedPrivate *priv = paned->priv;
1849 if (priv->saved_focus)
1850 g_object_remove_weak_pointer (G_OBJECT (priv->saved_focus),
1851 (gpointer *)&(priv->saved_focus));
1853 priv->saved_focus = widget;
1855 if (priv->saved_focus)
1856 g_object_add_weak_pointer (G_OBJECT (priv->saved_focus),
1857 (gpointer *)&(priv->saved_focus));
1861 gtk_paned_set_first_paned (GtkPaned *paned, GtkPaned *first_paned)
1863 GtkPanedPrivate *priv = paned->priv;
1865 if (priv->first_paned)
1866 g_object_remove_weak_pointer (G_OBJECT (priv->first_paned),
1867 (gpointer *)&(priv->first_paned));
1869 priv->first_paned = first_paned;
1871 if (priv->first_paned)
1872 g_object_add_weak_pointer (G_OBJECT (priv->first_paned),
1873 (gpointer *)&(priv->first_paned));
1877 gtk_paned_set_last_child1_focus (GtkPaned *paned, GtkWidget *widget)
1879 GtkPanedPrivate *priv = paned->priv;
1881 if (priv->last_child1_focus)
1882 g_object_remove_weak_pointer (G_OBJECT (priv->last_child1_focus),
1883 (gpointer *)&(priv->last_child1_focus));
1885 priv->last_child1_focus = widget;
1887 if (priv->last_child1_focus)
1888 g_object_add_weak_pointer (G_OBJECT (priv->last_child1_focus),
1889 (gpointer *)&(priv->last_child1_focus));
1893 gtk_paned_set_last_child2_focus (GtkPaned *paned, GtkWidget *widget)
1895 GtkPanedPrivate *priv = paned->priv;
1897 if (priv->last_child2_focus)
1898 g_object_remove_weak_pointer (G_OBJECT (priv->last_child2_focus),
1899 (gpointer *)&(priv->last_child2_focus));
1901 priv->last_child2_focus = widget;
1903 if (priv->last_child2_focus)
1904 g_object_add_weak_pointer (G_OBJECT (priv->last_child2_focus),
1905 (gpointer *)&(priv->last_child2_focus));
1909 paned_get_focus_widget (GtkPaned *paned)
1911 GtkWidget *toplevel;
1913 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1914 if (gtk_widget_is_toplevel (toplevel))
1915 return gtk_window_get_focus (GTK_WINDOW (toplevel));
1921 gtk_paned_set_focus_child (GtkContainer *container,
1922 GtkWidget *focus_child)
1925 GtkPanedPrivate *priv;
1926 GtkWidget *container_focus_child;
1928 g_return_if_fail (GTK_IS_PANED (container));
1930 paned = GTK_PANED (container);
1933 if (focus_child == NULL)
1935 GtkWidget *last_focus;
1938 last_focus = paned_get_focus_widget (paned);
1942 /* If there is one or more paned widgets between us and the
1943 * focus widget, we want the topmost of those as last_focus
1945 for (w = last_focus; w != GTK_WIDGET (paned); w = gtk_widget_get_parent (w))
1946 if (GTK_IS_PANED (w))
1949 container_focus_child = gtk_container_get_focus_child (container);
1950 if (container_focus_child == priv->child1)
1951 gtk_paned_set_last_child1_focus (paned, last_focus);
1952 else if (container_focus_child == priv->child2)
1953 gtk_paned_set_last_child2_focus (paned, last_focus);
1957 if (GTK_CONTAINER_CLASS (gtk_paned_parent_class)->set_focus_child)
1958 GTK_CONTAINER_CLASS (gtk_paned_parent_class)->set_focus_child (container, focus_child);
1962 gtk_paned_get_cycle_chain (GtkPaned *paned,
1963 GtkDirectionType direction,
1966 GtkPanedPrivate *priv = paned->priv;
1967 GtkContainer *container = GTK_CONTAINER (paned);
1968 GtkWidget *ancestor = NULL;
1969 GtkWidget *focus_child;
1971 GtkWidget *widget = GTK_WIDGET (paned);
1972 GList *temp_list = NULL;
1975 if (priv->in_recursion)
1978 g_assert (widgets != NULL);
1980 if (priv->last_child1_focus &&
1981 !gtk_widget_is_ancestor (priv->last_child1_focus, widget))
1983 gtk_paned_set_last_child1_focus (paned, NULL);
1986 if (priv->last_child2_focus &&
1987 !gtk_widget_is_ancestor (priv->last_child2_focus, widget))
1989 gtk_paned_set_last_child2_focus (paned, NULL);
1992 parent = gtk_widget_get_parent (widget);
1994 ancestor = gtk_widget_get_ancestor (parent, GTK_TYPE_PANED);
1996 /* The idea here is that temp_list is a list of widgets we want to cycle
1997 * to. The list is prioritized so that the first element is our first
1998 * choice, the next our second, and so on.
2000 * We can't just use g_list_reverse(), because we want to try
2001 * priv->last_child?_focus before priv->child?, both when we
2002 * are going forward and backward.
2004 focus_child = gtk_container_get_focus_child (container);
2005 if (direction == GTK_DIR_TAB_FORWARD)
2007 if (focus_child == priv->child1)
2009 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2010 temp_list = g_list_append (temp_list, priv->child2);
2011 temp_list = g_list_append (temp_list, ancestor);
2013 else if (focus_child == priv->child2)
2015 temp_list = g_list_append (temp_list, ancestor);
2016 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2017 temp_list = g_list_append (temp_list, priv->child1);
2021 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2022 temp_list = g_list_append (temp_list, priv->child1);
2023 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2024 temp_list = g_list_append (temp_list, priv->child2);
2025 temp_list = g_list_append (temp_list, ancestor);
2030 if (focus_child == priv->child1)
2032 temp_list = g_list_append (temp_list, ancestor);
2033 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2034 temp_list = g_list_append (temp_list, priv->child2);
2036 else if (focus_child == priv->child2)
2038 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2039 temp_list = g_list_append (temp_list, priv->child1);
2040 temp_list = g_list_append (temp_list, ancestor);
2044 temp_list = g_list_append (temp_list, priv->last_child2_focus);
2045 temp_list = g_list_append (temp_list, priv->child2);
2046 temp_list = g_list_append (temp_list, priv->last_child1_focus);
2047 temp_list = g_list_append (temp_list, priv->child1);
2048 temp_list = g_list_append (temp_list, ancestor);
2052 /* Walk the list and expand all the paned widgets. */
2053 for (list = temp_list; list != NULL; list = list->next)
2055 GtkWidget *widget = list->data;
2059 if (GTK_IS_PANED (widget))
2061 priv->in_recursion = TRUE;
2062 gtk_paned_get_cycle_chain (GTK_PANED (widget), direction, widgets);
2063 priv->in_recursion = FALSE;
2067 *widgets = g_list_append (*widgets, widget);
2072 g_list_free (temp_list);
2076 gtk_paned_cycle_child_focus (GtkPaned *paned,
2079 GList *cycle_chain = NULL;
2082 GtkDirectionType direction = reversed? GTK_DIR_TAB_BACKWARD : GTK_DIR_TAB_FORWARD;
2084 /* ignore f6 if the handle is focused */
2085 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2088 /* we can't just let the event propagate up the hierarchy,
2089 * because the paned will want to cycle focus _unless_ an
2090 * ancestor paned handles the event
2092 gtk_paned_get_cycle_chain (paned, direction, &cycle_chain);
2094 for (list = cycle_chain; list != NULL; list = list->next)
2095 if (gtk_widget_child_focus (GTK_WIDGET (list->data), direction))
2098 g_list_free (cycle_chain);
2104 get_child_panes (GtkWidget *widget,
2107 if (!widget || !gtk_widget_get_realized (widget))
2110 if (GTK_IS_PANED (widget))
2112 GtkPaned *paned = GTK_PANED (widget);
2113 GtkPanedPrivate *priv = paned->priv;
2115 get_child_panes (priv->child1, panes);
2116 *panes = g_list_prepend (*panes, widget);
2117 get_child_panes (priv->child2, panes);
2119 else if (GTK_IS_CONTAINER (widget))
2121 gtk_container_forall (GTK_CONTAINER (widget),
2122 (GtkCallback)get_child_panes, panes);
2127 get_all_panes (GtkPaned *paned)
2129 GtkPaned *topmost = NULL;
2130 GList *result = NULL;
2133 for (w = GTK_WIDGET (paned); w != NULL; w = gtk_widget_get_parent (w))
2135 if (GTK_IS_PANED (w))
2136 topmost = GTK_PANED (w);
2141 get_child_panes (GTK_WIDGET (topmost), &result);
2143 return g_list_reverse (result);
2147 gtk_paned_find_neighbours (GtkPaned *paned,
2154 all_panes = get_all_panes (paned);
2155 g_assert (all_panes);
2157 this_link = g_list_find (all_panes, paned);
2159 g_assert (this_link);
2161 if (this_link->next)
2162 *next = this_link->next->data;
2164 *next = all_panes->data;
2166 if (this_link->prev)
2167 *prev = this_link->prev->data;
2169 *prev = g_list_last (all_panes)->data;
2171 g_list_free (all_panes);
2175 gtk_paned_move_handle (GtkPaned *paned,
2176 GtkScrollType scroll)
2178 GtkPanedPrivate *priv = paned->priv;
2180 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2187 SINGLE_STEP_SIZE = 1,
2191 new_position = old_position = gtk_paned_get_position (paned);
2196 case GTK_SCROLL_STEP_LEFT:
2197 case GTK_SCROLL_STEP_UP:
2198 case GTK_SCROLL_STEP_BACKWARD:
2199 increment = - SINGLE_STEP_SIZE;
2202 case GTK_SCROLL_STEP_RIGHT:
2203 case GTK_SCROLL_STEP_DOWN:
2204 case GTK_SCROLL_STEP_FORWARD:
2205 increment = SINGLE_STEP_SIZE;
2208 case GTK_SCROLL_PAGE_LEFT:
2209 case GTK_SCROLL_PAGE_UP:
2210 case GTK_SCROLL_PAGE_BACKWARD:
2211 increment = - PAGE_STEP_SIZE;
2214 case GTK_SCROLL_PAGE_RIGHT:
2215 case GTK_SCROLL_PAGE_DOWN:
2216 case GTK_SCROLL_PAGE_FORWARD:
2217 increment = PAGE_STEP_SIZE;
2220 case GTK_SCROLL_START:
2221 new_position = priv->min_position;
2224 case GTK_SCROLL_END:
2225 new_position = priv->max_position;
2235 increment = -increment;
2237 new_position = old_position + increment;
2240 new_position = CLAMP (new_position, priv->min_position, priv->max_position);
2242 if (old_position != new_position)
2243 gtk_paned_set_position (paned, new_position);
2252 gtk_paned_restore_focus (GtkPaned *paned)
2254 GtkPanedPrivate *priv = paned->priv;
2256 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2258 if (priv->saved_focus &&
2259 gtk_widget_get_sensitive (priv->saved_focus))
2261 gtk_widget_grab_focus (priv->saved_focus);
2265 /* the saved focus is somehow not available for focusing,
2267 * 1) tabbing into the paned widget
2268 * if that didn't work,
2269 * 2) unset focus for the window if there is one
2272 if (!gtk_widget_child_focus (GTK_WIDGET (paned), GTK_DIR_TAB_FORWARD))
2274 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
2276 if (GTK_IS_WINDOW (toplevel))
2277 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
2281 gtk_paned_set_saved_focus (paned, NULL);
2282 gtk_paned_set_first_paned (paned, NULL);
2287 gtk_paned_accept_position (GtkPaned *paned)
2289 GtkPanedPrivate *priv = paned->priv;
2291 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2293 priv->original_position = -1;
2294 gtk_paned_restore_focus (paned);
2304 gtk_paned_cancel_position (GtkPaned *paned)
2306 GtkPanedPrivate *priv = paned->priv;
2308 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2310 if (priv->original_position != -1)
2312 gtk_paned_set_position (paned, priv->original_position);
2313 priv->original_position = -1;
2316 gtk_paned_restore_focus (paned);
2324 gtk_paned_cycle_handle_focus (GtkPaned *paned,
2327 GtkPanedPrivate *priv = paned->priv;
2328 GtkPaned *next, *prev;
2330 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2332 GtkPaned *focus = NULL;
2334 if (!priv->first_paned)
2336 /* The first_pane has disappeared. As an ad-hoc solution,
2337 * we make the currently focused paned the first_paned. To the
2338 * user this will seem like the paned cycling has been reset.
2341 gtk_paned_set_first_paned (paned, paned);
2344 gtk_paned_find_neighbours (paned, &next, &prev);
2346 if (reversed && prev &&
2347 prev != paned && paned != priv->first_paned)
2351 else if (!reversed && next &&
2352 next != paned && next != priv->first_paned)
2358 gtk_paned_accept_position (paned);
2364 gtk_paned_set_saved_focus (focus, priv->saved_focus);
2365 gtk_paned_set_first_paned (focus, priv->first_paned);
2367 gtk_paned_set_saved_focus (paned, NULL);
2368 gtk_paned_set_first_paned (paned, NULL);
2370 gtk_widget_grab_focus (GTK_WIDGET (focus));
2372 if (!gtk_widget_is_focus (GTK_WIDGET (paned)))
2374 priv->original_position = -1;
2375 focus->priv->original_position = gtk_paned_get_position (focus);
2380 GtkContainer *container = GTK_CONTAINER (paned);
2383 GtkPaned *prev, *next;
2384 GtkWidget *toplevel;
2385 GtkWidget *focus_child;
2387 gtk_paned_find_neighbours (paned, &next, &prev);
2388 focus_child = gtk_container_get_focus_child (container);
2390 if (focus_child == priv->child1)
2403 else if (focus_child == priv->child2)
2418 /* Focus is not inside this paned, and we don't have focus.
2419 * Presumably this happened because the application wants us
2420 * to start keyboard navigating.
2430 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
2432 if (GTK_IS_WINDOW (toplevel))
2433 gtk_paned_set_saved_focus (focus, gtk_window_get_focus (GTK_WINDOW (toplevel)));
2434 gtk_paned_set_first_paned (focus, first);
2435 focus->priv->original_position = gtk_paned_get_position (focus);
2437 gtk_widget_grab_focus (GTK_WIDGET (focus));
2444 gtk_paned_toggle_handle_focus (GtkPaned *paned)
2446 /* This function/signal has the wrong name. It is called when you
2447 * press Tab or Shift-Tab and what we do is act as if
2448 * the user pressed Return and then Tab or Shift-Tab
2450 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
2451 gtk_paned_accept_position (paned);
2457 * gtk_paned_get_handle_window:
2458 * @paned: a #GtkPaned
2460 * Returns the #GdkWindow of the handle. This function is
2461 * useful when handling button or motion events because it
2462 * enables the callback to distinguish between the window
2463 * of the paned, a child and the handle.
2465 * Return value: (transfer none): the paned's handle window.
2470 gtk_paned_get_handle_window (GtkPaned *paned)
2472 g_return_val_if_fail (GTK_IS_PANED (paned), NULL);
2474 return paned->priv->handle;