]> Pileus Git - ~andy/gtk/blob - gtk/gtkpaned.c
New GtkPaned keyboard navigation. (Shift-)F8 now cycles the available
[~andy/gtk] / gtk / gtkpaned.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/. 
25  */
26
27 #include "gtkintl.h"
28 #include "gtkpaned.h"
29 #include "gtkbindings.h"
30 #include "gtksignal.h"
31 #include "gdk/gdkkeysyms.h"
32 #include "gtkwindow.h"
33 #include "gtkmain.h"
34 #include "gtkmarshalers.h"
35
36 enum {
37   PROP_0,
38   PROP_POSITION,
39   PROP_POSITION_SET
40 };
41
42 enum {
43   CYCLE_CHILD_FOCUS,
44   TOGGLE_HANDLE_FOCUS,
45   MOVE_HANDLE,
46   CYCLE_HANDLE_FOCUS,
47   ACCEPT_POSITION,
48   CANCEL_POSITION,
49   LAST_SIGNAL
50 };
51
52 static void     gtk_paned_class_init            (GtkPanedClass    *klass);
53 static void     gtk_paned_init                  (GtkPaned         *paned);
54 static void     gtk_paned_set_property          (GObject          *object,
55                                                  guint             prop_id,
56                                                  const GValue     *value,
57                                                  GParamSpec       *pspec);
58 static void     gtk_paned_get_property          (GObject          *object,
59                                                  guint             prop_id,
60                                                  GValue           *value,
61                                                  GParamSpec       *pspec);
62 static void     gtk_paned_finalize              (GObject          *object);
63 static void     gtk_paned_realize               (GtkWidget        *widget);
64 static void     gtk_paned_unrealize             (GtkWidget        *widget);
65 static void     gtk_paned_map                   (GtkWidget        *widget);
66 static void     gtk_paned_unmap                 (GtkWidget        *widget);
67 static gboolean gtk_paned_expose                (GtkWidget        *widget,
68                                                  GdkEventExpose   *event);
69 static gboolean gtk_paned_enter                 (GtkWidget        *widget,
70                                                  GdkEventCrossing *event);
71 static gboolean gtk_paned_leave                 (GtkWidget        *widget,
72                                                  GdkEventCrossing *event);
73 static gboolean gtk_paned_button_press          (GtkWidget        *widget,
74                                                  GdkEventButton   *event);
75 static gboolean gtk_paned_button_release        (GtkWidget        *widget,
76                                                  GdkEventButton   *event);
77 static gboolean gtk_paned_motion                (GtkWidget        *widget,
78                                                  GdkEventMotion   *event);
79 static gboolean gtk_paned_focus                 (GtkWidget        *widget,
80                                                  GtkDirectionType  direction);
81 static void     gtk_paned_add                   (GtkContainer     *container,
82                                                  GtkWidget        *widget);
83 static void     gtk_paned_remove                (GtkContainer     *container,
84                                                  GtkWidget        *widget);
85 static void     gtk_paned_forall                (GtkContainer     *container,
86                                                  gboolean          include_internals,
87                                                  GtkCallback       callback,
88                                                  gpointer          callback_data);
89 static void     gtk_paned_set_focus_child       (GtkContainer     *container,
90                                                  GtkWidget        *child);
91 static void     gtk_paned_set_saved_focus       (GtkPaned         *paned,
92                                                  GtkWidget        *widget);
93 static void     gtk_paned_set_first_paned       (GtkPaned         *paned,
94                                                  GtkPaned         *first_paned);
95 static void     gtk_paned_set_last_child1_focus (GtkPaned         *paned,
96                                                  GtkWidget        *widget);
97 static void     gtk_paned_set_last_child2_focus (GtkPaned         *paned,
98                                                  GtkWidget        *widget);
99 static gboolean gtk_paned_cycle_child_focus     (GtkPaned         *paned,
100                                                  gboolean          reverse);
101 static gboolean gtk_paned_cycle_handle_focus    (GtkPaned         *paned,
102                                                  gboolean          reverse);
103 static gboolean gtk_paned_move_handle           (GtkPaned         *paned,
104                                                  GtkScrollType     scroll);
105 static gboolean gtk_paned_accept_position       (GtkPaned         *paned);
106 static gboolean gtk_paned_cancel_position       (GtkPaned         *paned);
107 static gboolean gtk_paned_toggle_handle_focus   (GtkPaned         *paned);
108
109 static GType    gtk_paned_child_type             (GtkContainer     *container);
110
111 static GtkContainerClass *parent_class = NULL;
112
113 struct _GtkPanedPrivate
114 {
115   GtkWidget *saved_focus;
116   GtkPaned *first_paned;
117 };
118
119 GType
120 gtk_paned_get_type (void)
121 {
122   static GType paned_type = 0;
123   
124   if (!paned_type)
125     {
126       static const GTypeInfo paned_info =
127       {
128         sizeof (GtkPanedClass),
129         NULL,           /* base_init */
130         NULL,           /* base_finalize */
131         (GClassInitFunc) gtk_paned_class_init,
132         NULL,           /* class_finalize */
133         NULL,           /* class_data */
134         sizeof (GtkPaned),
135         0,              /* n_preallocs */
136         (GInstanceInitFunc) gtk_paned_init,
137         NULL,           /* value_table */
138       };
139
140       paned_type = g_type_register_static (GTK_TYPE_CONTAINER, "GtkPaned",
141                                            &paned_info, G_TYPE_FLAG_ABSTRACT);
142     }
143   
144   return paned_type;
145 }
146
147 static guint signals[LAST_SIGNAL] = { 0 };
148
149 static void
150 add_tab_bindings (GtkBindingSet    *binding_set,
151                   GdkModifierType   modifiers)
152 {
153   gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
154                                 "toggle_handle_focus", 0);
155   gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
156                                 "toggle_handle_focus", 0);
157 }
158
159 static void
160 add_move_binding (GtkBindingSet   *binding_set,
161                   guint            keyval,
162                   GdkModifierType  mask,
163                   GtkScrollType    scroll)
164 {
165   gtk_binding_entry_add_signal (binding_set, keyval, mask,
166                                 "move_handle", 1,
167                                 GTK_TYPE_SCROLL_TYPE, scroll);
168 }
169
170 static void
171 gtk_paned_class_init (GtkPanedClass *class)
172 {
173   GObjectClass *object_class;
174   GtkWidgetClass *widget_class;
175   GtkContainerClass *container_class;
176   GtkPanedClass *paned_class;
177   GtkBindingSet *binding_set;
178
179   object_class = (GObjectClass *) class;
180   widget_class = (GtkWidgetClass *) class;
181   container_class = (GtkContainerClass *) class;
182   paned_class = (GtkPanedClass *) class;
183
184   parent_class = g_type_class_peek_parent (class);
185
186   object_class->set_property = gtk_paned_set_property;
187   object_class->get_property = gtk_paned_get_property;
188   object_class->finalize = gtk_paned_finalize;
189
190   widget_class->realize = gtk_paned_realize;
191   widget_class->unrealize = gtk_paned_unrealize;
192   widget_class->map = gtk_paned_map;
193   widget_class->unmap = gtk_paned_unmap;
194   widget_class->expose_event = gtk_paned_expose;
195   widget_class->focus = gtk_paned_focus;
196   widget_class->enter_notify_event = gtk_paned_enter;
197   widget_class->leave_notify_event = gtk_paned_leave;
198   widget_class->button_press_event = gtk_paned_button_press;
199   widget_class->button_release_event = gtk_paned_button_release;
200   widget_class->motion_notify_event = gtk_paned_motion;
201   
202   container_class->add = gtk_paned_add;
203   container_class->remove = gtk_paned_remove;
204   container_class->forall = gtk_paned_forall;
205   container_class->child_type = gtk_paned_child_type;
206   container_class->set_focus_child = gtk_paned_set_focus_child;
207
208   paned_class->cycle_child_focus = gtk_paned_cycle_child_focus;
209   paned_class->toggle_handle_focus = gtk_paned_toggle_handle_focus;
210   paned_class->move_handle = gtk_paned_move_handle;
211   paned_class->cycle_handle_focus = gtk_paned_cycle_handle_focus;
212   paned_class->accept_position = gtk_paned_accept_position;
213   paned_class->cancel_position = gtk_paned_cancel_position;
214
215   g_object_class_install_property (object_class,
216                                    PROP_POSITION,
217                                    g_param_spec_int ("position",
218                                                      _("Position"),
219                                                      _("Position of paned separator in pixels (0 means all the way to the left/top)"),
220                                                      0,
221                                                      G_MAXINT,
222                                                      0,
223                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));
224   g_object_class_install_property (object_class,
225                                    PROP_POSITION_SET,
226                                    g_param_spec_boolean ("position_set",
227                                                          _("Position Set"),
228                                                          _("TRUE if the Position property should be used"),
229                                                          FALSE,
230                                                          G_PARAM_READABLE | G_PARAM_WRITABLE));
231                                    
232   gtk_widget_class_install_style_property (widget_class,
233                                            g_param_spec_int ("handle_size",
234                                                              _("Handle Size"),
235                                                              _("Width of handle"),
236                                                              0,
237                                                              G_MAXINT,
238                                                              5,
239                                                              G_PARAM_READABLE));
240
241   signals [CYCLE_HANDLE_FOCUS] =
242     g_signal_new ("cycle_child_focus",
243                   G_TYPE_FROM_CLASS (object_class),
244                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
245                   G_STRUCT_OFFSET (GtkPanedClass, cycle_child_focus),
246                   NULL, NULL,
247                   _gtk_marshal_BOOLEAN__BOOLEAN,
248                   G_TYPE_BOOLEAN, 1,
249                   G_TYPE_BOOLEAN);
250
251   signals [TOGGLE_HANDLE_FOCUS] =
252     g_signal_new ("toggle_handle_focus",
253                   G_TYPE_FROM_CLASS (object_class),
254                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
255                   G_STRUCT_OFFSET (GtkPanedClass, toggle_handle_focus),
256                   NULL, NULL,
257                   _gtk_marshal_BOOLEAN__VOID,
258                   G_TYPE_BOOLEAN, 0);
259
260   signals[MOVE_HANDLE] =
261     g_signal_new ("move_handle",
262                   G_TYPE_FROM_CLASS (object_class),
263                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
264                   G_STRUCT_OFFSET (GtkPanedClass, move_handle),
265                   NULL, NULL,
266                   _gtk_marshal_BOOLEAN__ENUM,
267                   G_TYPE_BOOLEAN, 1,
268                   GTK_TYPE_SCROLL_TYPE);
269
270   signals [CYCLE_HANDLE_FOCUS] =
271     g_signal_new ("cycle_handle_focus",
272                   G_TYPE_FROM_CLASS (object_class),
273                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
274                   G_STRUCT_OFFSET (GtkPanedClass, cycle_handle_focus),
275                   NULL, NULL,
276                   _gtk_marshal_BOOLEAN__BOOLEAN,
277                   G_TYPE_BOOLEAN, 1,
278                   G_TYPE_BOOLEAN);
279
280   signals [ACCEPT_POSITION] =
281     g_signal_new ("accept_position",
282                   G_TYPE_FROM_CLASS (object_class),
283                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
284                   G_STRUCT_OFFSET (GtkPanedClass, accept_position),
285                   NULL, NULL,
286                   _gtk_marshal_BOOLEAN__VOID,
287                   G_TYPE_BOOLEAN, 0);
288
289   signals [CANCEL_POSITION] =
290     g_signal_new ("cancel_position",
291                   G_TYPE_FROM_CLASS (object_class),
292                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
293                   G_STRUCT_OFFSET (GtkPanedClass, cancel_position),
294                   NULL, NULL,
295                   _gtk_marshal_BOOLEAN__VOID,
296                   G_TYPE_BOOLEAN, 0);
297
298   binding_set = gtk_binding_set_by_class (class);
299
300   /* F6 and friends */
301   gtk_binding_entry_add_signal (binding_set,                            
302                                 GDK_F6, 0,
303                                 "cycle_child_focus", 1, 
304                                 G_TYPE_BOOLEAN, FALSE);
305   gtk_binding_entry_add_signal (binding_set,
306                                 GDK_F6, GDK_SHIFT_MASK,
307                                 "cycle_child_focus", 1,
308                                 G_TYPE_BOOLEAN, TRUE);
309
310   /* F8 and friends */
311   gtk_binding_entry_add_signal (binding_set,
312                                 GDK_F8, 0,
313                                 "cycle_handle_focus", 1,
314                                 G_TYPE_BOOLEAN, FALSE);
315  
316   gtk_binding_entry_add_signal (binding_set,
317                                 GDK_F8, GDK_SHIFT_MASK,
318                                 "cycle_handle_focus", 1,
319                                 G_TYPE_BOOLEAN, TRUE);
320  
321   add_tab_bindings (binding_set, 0);
322   add_tab_bindings (binding_set, GDK_CONTROL_MASK);
323   add_tab_bindings (binding_set, GDK_SHIFT_MASK);
324   add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK);
325
326   /* accept and cancel positions */
327   gtk_binding_entry_add_signal (binding_set,
328                                 GDK_Escape, 0,
329                                 "cancel_position", 0);
330
331   gtk_binding_entry_add_signal (binding_set,
332                                 GDK_Return, 0,
333                                 "accept_position", 0);
334   gtk_binding_entry_add_signal (binding_set,
335                                 GDK_KP_Enter, 0,
336                                 "accept_position", 0);
337   gtk_binding_entry_add_signal (binding_set,
338                                 GDK_space, 0,
339                                 "accept_position", 0);
340   gtk_binding_entry_add_signal (binding_set,
341                                 GDK_KP_Space, 0,
342                                 "accept_position", 0);
343
344   /* move handle */
345   add_move_binding (binding_set, GDK_Left, 0, GTK_SCROLL_STEP_LEFT);
346   add_move_binding (binding_set, GDK_KP_Left, 0, GTK_SCROLL_STEP_LEFT);
347   add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
348   add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
349
350   add_move_binding (binding_set, GDK_Right, 0, GTK_SCROLL_STEP_RIGHT);
351   add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
352   add_move_binding (binding_set, GDK_KP_Right, 0, GTK_SCROLL_STEP_RIGHT);
353   add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
354
355   add_move_binding (binding_set, GDK_Up, 0, GTK_SCROLL_STEP_UP);
356   add_move_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
357   add_move_binding (binding_set, GDK_KP_Up, 0, GTK_SCROLL_STEP_UP);
358   add_move_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
359   add_move_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_UP);
360   add_move_binding (binding_set, GDK_KP_Page_Up, 0, GTK_SCROLL_PAGE_UP);
361
362   add_move_binding (binding_set, GDK_Down, 0, GTK_SCROLL_STEP_DOWN);
363   add_move_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
364   add_move_binding (binding_set, GDK_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
365   add_move_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
366   add_move_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
367   add_move_binding (binding_set, GDK_KP_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
368
369   add_move_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START);
370   add_move_binding (binding_set, GDK_KP_Home, 0, GTK_SCROLL_START);
371   add_move_binding (binding_set, GDK_End, 0, GTK_SCROLL_END);
372   add_move_binding (binding_set, GDK_KP_End, 0, GTK_SCROLL_END);
373 }
374
375 static GType
376 gtk_paned_child_type (GtkContainer *container)
377 {
378   if (!GTK_PANED (container)->child1 || !GTK_PANED (container)->child2)
379     return GTK_TYPE_WIDGET;
380   else
381     return G_TYPE_NONE;
382 }
383
384 static void
385 gtk_paned_init (GtkPaned *paned)
386 {
387   GTK_WIDGET_SET_FLAGS (paned, GTK_NO_WINDOW | GTK_CAN_FOCUS);
388   
389   paned->child1 = NULL;
390   paned->child2 = NULL;
391   paned->handle = NULL;
392   paned->xor_gc = NULL;
393   paned->cursor_type = GDK_CROSS;
394   
395   paned->handle_pos.width = 5;
396   paned->handle_pos.height = 5;
397   paned->position_set = FALSE;
398   paned->last_allocation = -1;
399   paned->in_drag = FALSE;
400
401   paned->priv = g_new0 (GtkPanedPrivate, 1);
402   paned->last_child1_focus = NULL;
403   paned->last_child2_focus = NULL;
404   paned->in_recursion = FALSE;
405   paned->handle_prelit = FALSE;
406   paned->original_position = -1;
407   
408   paned->handle_pos.x = -1;
409   paned->handle_pos.y = -1;
410
411   paned->drag_pos = -1;
412 }
413
414 static void
415 gtk_paned_set_property (GObject        *object,
416                         guint           prop_id,
417                         const GValue   *value,
418                         GParamSpec     *pspec)
419 {
420   GtkPaned *paned = GTK_PANED (object);
421   
422   switch (prop_id)
423     {
424     case PROP_POSITION:
425       gtk_paned_set_position (paned, g_value_get_int (value));
426       break;
427     case PROP_POSITION_SET:
428       paned->position_set = g_value_get_boolean (value);
429       gtk_widget_queue_resize (GTK_WIDGET (paned));
430       break;
431     default:
432       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
433       break;
434     }
435 }
436
437 static void
438 gtk_paned_get_property (GObject        *object,
439                         guint           prop_id,
440                         GValue         *value,
441                         GParamSpec     *pspec)
442 {
443   GtkPaned *paned = GTK_PANED (object);
444   
445   switch (prop_id)
446     {
447     case PROP_POSITION:
448       g_value_set_int (value, paned->child1_size);
449       break;
450     case PROP_POSITION_SET:
451       g_value_set_boolean (value, paned->position_set);
452       break;
453     default:
454       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
455       break;
456     }
457 }
458
459 static void
460 gtk_paned_finalize (GObject *object)
461 {
462   GtkPaned *paned = GTK_PANED (object);
463   
464   gtk_paned_set_saved_focus (paned, NULL);
465   gtk_paned_set_first_paned (paned, NULL);
466
467   g_free (paned->priv);
468
469   G_OBJECT_CLASS (parent_class)->finalize (object);
470 }
471
472 static void
473 gtk_paned_realize (GtkWidget *widget)
474 {
475   GtkPaned *paned;
476   GdkWindowAttr attributes;
477   gint attributes_mask;
478
479   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
480   paned = GTK_PANED (widget);
481
482   widget->window = gtk_widget_get_parent_window (widget);
483   g_object_ref (widget->window);
484   
485   attributes.window_type = GDK_WINDOW_CHILD;
486   attributes.wclass = GDK_INPUT_ONLY;
487   attributes.x = paned->handle_pos.x;
488   attributes.y = paned->handle_pos.y;
489   attributes.width = paned->handle_pos.width;
490   attributes.height = paned->handle_pos.height;
491   attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
492                                                   paned->cursor_type);
493   attributes.event_mask = gtk_widget_get_events (widget);
494   attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
495                             GDK_BUTTON_RELEASE_MASK |
496                             GDK_ENTER_NOTIFY_MASK |
497                             GDK_LEAVE_NOTIFY_MASK |
498                             GDK_POINTER_MOTION_MASK |
499                             GDK_POINTER_MOTION_HINT_MASK);
500   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_CURSOR;
501
502   paned->handle = gdk_window_new (widget->window,
503                                   &attributes, attributes_mask);
504   gdk_window_set_user_data (paned->handle, paned);
505   gdk_cursor_unref (attributes.cursor);
506
507   widget->style = gtk_style_attach (widget->style, widget->window);
508
509   if (paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
510       paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
511     gdk_window_show (paned->handle);
512 }
513
514 static void
515 gtk_paned_unrealize (GtkWidget *widget)
516 {
517   GtkPaned *paned = GTK_PANED (widget);
518
519   if (paned->xor_gc)
520     {
521       g_object_unref (paned->xor_gc);
522       paned->xor_gc = NULL;
523     }
524
525   if (paned->handle)
526     {
527       gdk_window_set_user_data (paned->handle, NULL);
528       gdk_window_destroy (paned->handle);
529       paned->handle = NULL;
530     }
531
532   gtk_paned_set_last_child1_focus (paned, NULL);
533   gtk_paned_set_last_child2_focus (paned, NULL);
534   gtk_paned_set_saved_focus (paned, NULL);
535   gtk_paned_set_first_paned (paned, NULL);
536   
537   if (GTK_WIDGET_CLASS (parent_class)->unrealize)
538     (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
539 }
540
541 static void
542 gtk_paned_map (GtkWidget *widget)
543 {
544   GtkPaned *paned = GTK_PANED (widget);
545
546   gdk_window_show (paned->handle);
547
548   GTK_WIDGET_CLASS (parent_class)->map (widget);
549 }
550
551 static void
552 gtk_paned_unmap (GtkWidget *widget)
553 {
554   GtkPaned *paned = GTK_PANED (widget);
555     
556   gdk_window_hide (paned->handle);
557
558   GTK_WIDGET_CLASS (parent_class)->unmap (widget);
559 }
560
561 static gboolean
562 gtk_paned_expose (GtkWidget      *widget,
563                   GdkEventExpose *event)
564 {
565   GtkPaned *paned = GTK_PANED (widget);
566
567   if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
568       paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
569       paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
570     {
571       GdkRegion *region;
572
573       region = gdk_region_rectangle (&paned->handle_pos);
574       gdk_region_intersect (region, event->region);
575
576       if (!gdk_region_empty (region))
577         {
578           GtkStateType state;
579           GdkRectangle clip;
580
581           gdk_region_get_clipbox (region, &clip);
582
583           if (gtk_widget_is_focus (widget))
584             state = GTK_STATE_SELECTED;
585           else if (paned->handle_prelit)
586             state = GTK_STATE_PRELIGHT;
587           else
588             state = GTK_WIDGET_STATE (widget);
589           
590           gtk_paint_handle (widget->style, widget->window,
591                             state, GTK_SHADOW_NONE,
592                             &clip, widget, "paned",
593                             paned->handle_pos.x, paned->handle_pos.y,
594                             paned->handle_pos.width, paned->handle_pos.height,
595                             paned->orientation);
596         }
597
598       gdk_region_destroy (region);
599     }
600
601   /* Chain up to draw children */
602   GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
603   
604   return FALSE;
605 }
606
607 static void
608 update_drag (GtkPaned *paned)
609 {
610   gint pos;
611   gint handle_size;
612   gint size;
613   
614   if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
615     gtk_widget_get_pointer (GTK_WIDGET (paned), NULL, &pos);
616   else
617     gtk_widget_get_pointer (GTK_WIDGET (paned), &pos, NULL);
618
619   gtk_widget_style_get (GTK_WIDGET (paned), "handle_size", &handle_size, NULL);
620   
621   size = pos - GTK_CONTAINER (paned)->border_width - paned->drag_pos;
622   size = CLAMP (size, paned->min_position, paned->max_position);
623
624   if (size != paned->child1_size)
625     gtk_paned_set_position (paned, size);
626 }
627
628 static gboolean
629 gtk_paned_enter (GtkWidget        *widget,
630                  GdkEventCrossing *event)
631 {
632   GtkPaned *paned = GTK_PANED (widget);
633   
634   if (paned->in_drag)
635     update_drag (paned);
636   else
637     {
638       paned->handle_prelit = TRUE;
639       gtk_widget_queue_draw_area (widget,
640                                   paned->handle_pos.x,
641                                   paned->handle_pos.y,
642                                   paned->handle_pos.width,
643                                   paned->handle_pos.height);
644     }
645   
646   return TRUE;
647 }
648
649 static gboolean
650 gtk_paned_leave (GtkWidget        *widget,
651                  GdkEventCrossing *event)
652 {
653   GtkPaned *paned = GTK_PANED (widget);
654   
655   if (paned->in_drag)
656     update_drag (paned);
657   else
658     {
659       paned->handle_prelit = FALSE;
660       gtk_widget_queue_draw_area (widget,
661                                   paned->handle_pos.x,
662                                   paned->handle_pos.y,
663                                   paned->handle_pos.width,
664                                   paned->handle_pos.height);
665     }
666
667   return TRUE;
668 }
669
670 static gboolean
671 gtk_paned_focus (GtkWidget        *widget,
672                  GtkDirectionType  direction)
673
674 {
675   gboolean retval;
676   
677   /* This is a hack, but how can this be done without
678    * excessive cut-and-paste from gtkcontainer.c?
679    */
680
681   GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
682   retval = (* GTK_WIDGET_CLASS (parent_class)->focus) (widget, direction);
683   GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
684
685   return retval;
686 }
687
688 static gboolean
689 gtk_paned_button_press (GtkWidget      *widget,
690                         GdkEventButton *event)
691 {
692   GtkPaned *paned = GTK_PANED (widget);
693
694   if (!paned->in_drag &&
695       (event->window == paned->handle) && (event->button == 1))
696     {
697       paned->in_drag = TRUE;
698
699       /* We need a server grab here, not gtk_grab_add(), since
700        * we don't want to pass events on to the widget's children */
701       gdk_pointer_grab (paned->handle, FALSE,
702                         GDK_POINTER_MOTION_HINT_MASK
703                         | GDK_BUTTON1_MOTION_MASK
704                         | GDK_BUTTON_RELEASE_MASK
705                         | GDK_ENTER_NOTIFY_MASK
706                         | GDK_LEAVE_NOTIFY_MASK,
707                         NULL, NULL,
708                         event->time);
709
710       if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
711         paned->drag_pos = event->y;
712       else
713         paned->drag_pos = event->x;
714       
715       return TRUE;
716     }
717
718   return FALSE;
719 }
720
721 static gboolean
722 gtk_paned_button_release (GtkWidget      *widget,
723                           GdkEventButton *event)
724 {
725   GtkPaned *paned = GTK_PANED (widget);
726
727   if (paned->in_drag && (event->button == 1))
728     {
729       paned->in_drag = FALSE;
730       paned->drag_pos = -1;
731       paned->position_set = TRUE;
732       gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
733                                   event->time);
734       return TRUE;
735     }
736
737   return FALSE;
738 }
739
740 static gboolean
741 gtk_paned_motion (GtkWidget      *widget,
742                   GdkEventMotion *event)
743 {
744   GtkPaned *paned = GTK_PANED (widget);
745   
746   if (paned->in_drag)
747     {
748       update_drag (paned);
749       return TRUE;
750     }
751   
752   return FALSE;
753 }
754
755 void
756 gtk_paned_add1 (GtkPaned  *paned,
757                 GtkWidget *widget)
758 {
759   gtk_paned_pack1 (paned, widget, FALSE, TRUE);
760 }
761
762 void
763 gtk_paned_add2 (GtkPaned  *paned,
764                 GtkWidget *widget)
765 {
766   gtk_paned_pack2 (paned, widget, TRUE, TRUE);
767 }
768
769 void
770 gtk_paned_pack1 (GtkPaned  *paned,
771                  GtkWidget *child,
772                  gboolean   resize,
773                  gboolean   shrink)
774 {
775   g_return_if_fail (GTK_IS_PANED (paned));
776   g_return_if_fail (GTK_IS_WIDGET (child));
777
778   if (!paned->child1)
779     {
780       paned->child1 = child;
781       paned->child1_resize = resize;
782       paned->child1_shrink = shrink;
783
784       gtk_widget_set_parent (child, GTK_WIDGET (paned));
785     }
786 }
787
788 void
789 gtk_paned_pack2 (GtkPaned  *paned,
790                  GtkWidget *child,
791                  gboolean   resize,
792                  gboolean   shrink)
793 {
794   g_return_if_fail (GTK_IS_PANED (paned));
795   g_return_if_fail (GTK_IS_WIDGET (child));
796
797   if (!paned->child2)
798     {
799       paned->child2 = child;
800       paned->child2_resize = resize;
801       paned->child2_shrink = shrink;
802
803       gtk_widget_set_parent (child, GTK_WIDGET (paned));
804     }
805 }
806
807
808 static void
809 gtk_paned_add (GtkContainer *container,
810                GtkWidget    *widget)
811 {
812   GtkPaned *paned;
813
814   g_return_if_fail (GTK_IS_PANED (container));
815
816   paned = GTK_PANED (container);
817
818   if (!paned->child1)
819     gtk_paned_add1 (paned, widget);
820   else if (!paned->child2)
821     gtk_paned_add2 (paned, widget);
822 }
823
824 static void
825 gtk_paned_remove (GtkContainer *container,
826                   GtkWidget    *widget)
827 {
828   GtkPaned *paned;
829   gboolean was_visible;
830
831   paned = GTK_PANED (container);
832   was_visible = GTK_WIDGET_VISIBLE (widget);
833
834   if (paned->child1 == widget)
835     {
836       gtk_widget_unparent (widget);
837
838       paned->child1 = NULL;
839
840       if (was_visible && GTK_WIDGET_VISIBLE (container))
841         gtk_widget_queue_resize (GTK_WIDGET (container));
842     }
843   else if (paned->child2 == widget)
844     {
845       gtk_widget_unparent (widget);
846
847       paned->child2 = NULL;
848
849       if (was_visible && GTK_WIDGET_VISIBLE (container))
850         gtk_widget_queue_resize (GTK_WIDGET (container));
851     }
852 }
853
854 static void
855 gtk_paned_forall (GtkContainer *container,
856                   gboolean      include_internals,
857                   GtkCallback   callback,
858                   gpointer      callback_data)
859 {
860   GtkPaned *paned;
861
862   g_return_if_fail (callback != NULL);
863
864   paned = GTK_PANED (container);
865
866   if (paned->child1)
867     (*callback) (paned->child1, callback_data);
868   if (paned->child2)
869     (*callback) (paned->child2, callback_data);
870 }
871
872 /**
873  * gtk_paned_get_position:
874  * @paned: a #GtkPaned widget
875  * 
876  * Obtains the position of the divider between the two panes.
877  * 
878  * Return value: position of the divider
879  **/
880 gint
881 gtk_paned_get_position (GtkPaned  *paned)
882 {
883   g_return_val_if_fail (GTK_IS_PANED (paned), 0);
884
885   return paned->child1_size;
886 }
887
888 /**
889  * gtk_paned_set_position:
890  * @paned: a #GtkPaned widget
891  * @position: pixel position of divider, a negative value means that the position
892  *            is unset.
893  * 
894  * Sets the position of the divider between the two panes.
895  **/
896 void
897 gtk_paned_set_position (GtkPaned *paned,
898                         gint      position)
899 {
900   GObject *object;
901   
902   g_return_if_fail (GTK_IS_PANED (paned));
903
904   object = G_OBJECT (paned);
905   
906   if (position >= 0)
907     {
908       /* We don't clamp here - the assumption is that
909        * if the total allocation changes at the same time
910        * as the position, the position set is with reference
911        * to the new total size. If only the position changes,
912        * then clamping will occur in gtk_paned_compute_position()
913        */
914
915       paned->child1_size = position;
916       paned->position_set = TRUE;
917     }
918   else
919     {
920       paned->position_set = FALSE;
921     }
922
923   g_object_freeze_notify (object);
924   g_object_notify (object, "position");
925   g_object_notify (object, "position_set");
926   g_object_thaw_notify (object);
927
928   gtk_widget_queue_resize (GTK_WIDGET (paned));
929 }
930
931 void
932 gtk_paned_compute_position (GtkPaned *paned,
933                             gint      allocation,
934                             gint      child1_req,
935                             gint      child2_req)
936 {
937   gint old_position;
938   
939   g_return_if_fail (GTK_IS_PANED (paned));
940
941   old_position = paned->child1_size;
942
943   paned->min_position = paned->child1_shrink ? 0 : child1_req;
944
945   paned->max_position = allocation;
946   if (!paned->child2_shrink)
947     paned->max_position = MAX (1, paned->max_position - child2_req);
948
949   if (!paned->position_set)
950     {
951       if (paned->child1_resize && !paned->child2_resize)
952         paned->child1_size = MAX (0, allocation - child2_req);
953       else if (!paned->child1_resize && paned->child2_resize)
954         paned->child1_size = child1_req;
955       else if (child1_req + child2_req != 0)
956         paned->child1_size = allocation * ((gdouble)child1_req / (child1_req + child2_req));
957       else
958         paned->child1_size = allocation * 0.5;
959     }
960   else
961     {
962       /* If the position was set before the initial allocation.
963        * (paned->last_allocation <= 0) just clamp it and leave it.
964        */
965       if (paned->last_allocation > 0)
966         {
967           if (paned->child1_resize && !paned->child2_resize)
968             paned->child1_size += allocation - paned->last_allocation;
969           else if (!(!paned->child1_resize && paned->child2_resize))
970             paned->child1_size = allocation * ((gdouble) paned->child1_size / (paned->last_allocation));
971         }
972     }
973
974   paned->child1_size = CLAMP (paned->child1_size,
975                               paned->min_position,
976                               paned->max_position);
977
978   gtk_widget_set_child_visible (paned->child1, paned->child1_size != 0);
979   gtk_widget_set_child_visible (paned->child2, paned->child1_size != allocation);
980
981   if (paned->child1_size != old_position)
982     g_object_notify (G_OBJECT (paned), "position");
983
984   paned->last_allocation = allocation;
985 }
986
987 static void
988 gtk_paned_set_saved_focus (GtkPaned *paned, GtkWidget *widget)
989 {
990   if (paned->priv->saved_focus)
991     g_object_remove_weak_pointer (G_OBJECT (paned->priv->saved_focus),
992                                   (gpointer *)&(paned->priv->saved_focus));
993
994   paned->priv->saved_focus = widget;
995
996   if (paned->priv->saved_focus)
997     g_object_add_weak_pointer (G_OBJECT (paned->priv->saved_focus),
998                                (gpointer *)&(paned->priv->saved_focus));
999 }
1000
1001 static void
1002 gtk_paned_set_first_paned (GtkPaned *paned, GtkPaned *first_paned)
1003 {
1004   if (paned->priv->first_paned)
1005     g_object_remove_weak_pointer (G_OBJECT (paned->priv->first_paned),
1006                                   (gpointer *)&(paned->priv->first_paned));
1007
1008   paned->priv->first_paned = first_paned;
1009
1010   if (paned->priv->first_paned)
1011     g_object_add_weak_pointer (G_OBJECT (paned->priv->first_paned),
1012                                (gpointer *)&(paned->priv->first_paned));
1013 }
1014
1015 static void
1016 gtk_paned_set_last_child1_focus (GtkPaned *paned, GtkWidget *widget)
1017 {
1018   if (paned->last_child1_focus)
1019     g_object_remove_weak_pointer (G_OBJECT (paned->last_child1_focus),
1020                                   (gpointer *)&(paned->last_child1_focus));
1021
1022   paned->last_child1_focus = widget;
1023
1024   if (paned->last_child1_focus)
1025     g_object_add_weak_pointer (G_OBJECT (paned->last_child1_focus),
1026                                (gpointer *)&(paned->last_child1_focus));
1027 }
1028
1029 static void
1030 gtk_paned_set_last_child2_focus (GtkPaned *paned, GtkWidget *widget)
1031 {
1032   if (paned->last_child2_focus)
1033     g_object_remove_weak_pointer (G_OBJECT (paned->last_child2_focus),
1034                                   (gpointer *)&(paned->last_child2_focus));
1035
1036   paned->last_child2_focus = widget;
1037
1038   if (paned->last_child2_focus)
1039     g_object_add_weak_pointer (G_OBJECT (paned->last_child2_focus),
1040                                (gpointer *)&(paned->last_child2_focus));
1041 }
1042
1043 static GtkWidget *
1044 paned_get_focus_widget (GtkPaned *paned)
1045 {
1046   GtkWidget *toplevel;
1047
1048   toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1049   if (GTK_WIDGET_TOPLEVEL (toplevel))
1050     return GTK_WINDOW (toplevel)->focus_widget;
1051
1052   return NULL;
1053 }
1054
1055 static void
1056 gtk_paned_set_focus_child (GtkContainer *container,
1057                            GtkWidget    *focus_child)
1058 {
1059   GtkPaned *paned;
1060   
1061   g_return_if_fail (GTK_IS_PANED (container));
1062
1063   paned = GTK_PANED (container);
1064  
1065   if (focus_child == NULL)
1066     {
1067       GtkWidget *last_focus;
1068       GtkWidget *w;
1069       
1070       last_focus = paned_get_focus_widget (paned);
1071
1072       if (last_focus)
1073         {
1074           /* If there is one or more paned widgets between us and the
1075            * focus widget, we want the topmost of those as last_focus
1076            */
1077           for (w = last_focus; w != GTK_WIDGET (paned); w = w->parent)
1078             if (GTK_IS_PANED (w))
1079               last_focus = w;
1080           
1081           if (container->focus_child == paned->child1)
1082             gtk_paned_set_last_child1_focus (paned, last_focus);
1083           else if (container->focus_child == paned->child2)
1084             gtk_paned_set_last_child2_focus (paned, last_focus);
1085         }
1086     }
1087
1088   if (parent_class->set_focus_child)
1089     (* parent_class->set_focus_child) (container, focus_child);
1090 }
1091
1092 static void
1093 gtk_paned_get_cycle_chain (GtkPaned          *paned,
1094                            GtkDirectionType   direction,
1095                            GList            **widgets)
1096 {
1097   GtkContainer *container = GTK_CONTAINER (paned);
1098   GtkWidget *ancestor = NULL;
1099   GList *temp_list = NULL;
1100   GList *list;
1101
1102   if (paned->in_recursion)
1103     return;
1104
1105   g_assert (widgets != NULL);
1106
1107   if (paned->last_child1_focus &&
1108       !gtk_widget_is_ancestor (paned->last_child1_focus, GTK_WIDGET (paned)))
1109     {
1110       gtk_paned_set_last_child1_focus (paned, NULL);
1111     }
1112
1113   if (paned->last_child2_focus &&
1114       !gtk_widget_is_ancestor (paned->last_child2_focus, GTK_WIDGET (paned)))
1115     {
1116       gtk_paned_set_last_child2_focus (paned, NULL);
1117     }
1118
1119   if (GTK_WIDGET (paned)->parent)
1120     ancestor = gtk_widget_get_ancestor (GTK_WIDGET (paned)->parent, GTK_TYPE_PANED);
1121
1122   /* The idea here is that temp_list is a list of widgets we want to cycle
1123    * to. The list is prioritized so that the first element is our first
1124    * choice, the next our second, and so on.
1125    *
1126    * We can't just use g_list_reverse(), because we want to try
1127    * paned->last_child?_focus before paned->child?, both when we
1128    * are going forward and backward.
1129    */
1130   if (direction == GTK_DIR_TAB_FORWARD)
1131     {
1132       if (container->focus_child == paned->child1)
1133         {
1134           temp_list = g_list_append (temp_list, paned->last_child2_focus);
1135           temp_list = g_list_append (temp_list, paned->child2);
1136           temp_list = g_list_append (temp_list, ancestor);
1137         }
1138       else if (container->focus_child == paned->child2)
1139         {
1140           temp_list = g_list_append (temp_list, ancestor);
1141           temp_list = g_list_append (temp_list, paned->last_child1_focus);
1142           temp_list = g_list_append (temp_list, paned->child1);
1143         }
1144       else
1145         {
1146           temp_list = g_list_append (temp_list, paned->last_child1_focus);
1147           temp_list = g_list_append (temp_list, paned->child1);
1148           temp_list = g_list_append (temp_list, paned->last_child2_focus);
1149           temp_list = g_list_append (temp_list, paned->child2);
1150           temp_list = g_list_append (temp_list, ancestor);
1151         }
1152     }
1153   else
1154     {
1155       if (container->focus_child == paned->child1)
1156         {
1157           temp_list = g_list_append (temp_list, ancestor);
1158           temp_list = g_list_append (temp_list, paned->last_child2_focus);
1159           temp_list = g_list_append (temp_list, paned->child2);
1160         }
1161       else if (container->focus_child == paned->child2)
1162         {
1163           temp_list = g_list_append (temp_list, paned->last_child1_focus);
1164           temp_list = g_list_append (temp_list, paned->child1);
1165           temp_list = g_list_append (temp_list, ancestor);
1166         }
1167       else
1168         {
1169           temp_list = g_list_append (temp_list, paned->last_child2_focus);
1170           temp_list = g_list_append (temp_list, paned->child2);
1171           temp_list = g_list_append (temp_list, paned->last_child1_focus);
1172           temp_list = g_list_append (temp_list, paned->child1);
1173           temp_list = g_list_append (temp_list, ancestor);
1174         }
1175     }
1176
1177   /* Walk the list and expand all the paned widgets. */
1178   for (list = temp_list; list != NULL; list = list->next)
1179     {
1180       GtkWidget *widget = list->data;
1181
1182       if (widget)
1183         {
1184           if (GTK_IS_PANED (widget))
1185             {
1186               paned->in_recursion = TRUE;
1187               gtk_paned_get_cycle_chain (GTK_PANED (widget), direction, widgets);
1188               paned->in_recursion = FALSE;
1189             }
1190           else
1191             {
1192               *widgets = g_list_append (*widgets, widget);
1193             }
1194         }
1195     }
1196
1197   g_list_free (temp_list);
1198 }
1199
1200 static gboolean
1201 gtk_paned_cycle_child_focus (GtkPaned *paned,
1202                              gboolean  reversed)
1203 {
1204   GList *cycle_chain = NULL;
1205   GList *list;
1206
1207   GtkDirectionType direction = reversed? GTK_DIR_TAB_BACKWARD : GTK_DIR_TAB_FORWARD;
1208
1209   /* ignore f6 if the handle is focused */
1210   if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1211     return TRUE;
1212   
1213   /* we can't just let the event propagate up the hierarchy,
1214    * because the paned will want to cycle focus _unless_ an
1215    * ancestor paned handles the event
1216    */
1217   gtk_paned_get_cycle_chain (paned, direction, &cycle_chain);
1218
1219   for (list = cycle_chain; list != NULL; list = list->next)
1220     if (gtk_widget_child_focus (GTK_WIDGET (list->data), direction))
1221       break;
1222
1223   g_list_free (cycle_chain);
1224   
1225   return TRUE;
1226 }
1227
1228 static void
1229 get_child_panes (GtkWidget  *widget,
1230                  GList     **panes)
1231 {
1232   if (GTK_IS_PANED (widget))
1233     {
1234       GtkPaned *paned = GTK_PANED (widget);
1235       
1236       get_child_panes (paned->child1, panes);
1237       *panes = g_list_prepend (*panes, widget);
1238       get_child_panes (paned->child2, panes);
1239     }
1240   else if (GTK_IS_CONTAINER (widget))
1241     {
1242       gtk_container_foreach (GTK_CONTAINER (widget),
1243                              (GtkCallback)get_child_panes, panes);
1244     }
1245 }
1246
1247 static GList *
1248 get_all_panes (GtkPaned *paned)
1249 {
1250   GtkPaned *topmost = NULL;
1251   GList *result = NULL;
1252   GtkWidget *w;
1253   
1254   for (w = GTK_WIDGET (paned); w != NULL; w = w->parent)
1255     {
1256       if (GTK_IS_PANED (w))
1257         topmost = GTK_PANED (w);
1258     }
1259
1260   g_assert (topmost);
1261
1262   get_child_panes (GTK_WIDGET (topmost), &result);
1263
1264   return g_list_reverse (result);
1265 }
1266
1267 static void
1268 gtk_paned_find_neighbours (GtkPaned  *paned,
1269                            GtkPaned **next,
1270                            GtkPaned **prev)
1271 {
1272   GList *all_panes;
1273   GList *this_link;
1274
1275   all_panes = get_all_panes (paned);
1276   g_assert (all_panes);
1277
1278   this_link = g_list_find (all_panes, paned);
1279
1280   g_assert (this_link);
1281   
1282   if (this_link->next)
1283     *next = this_link->next->data;
1284   else
1285     *next = all_panes->data;
1286
1287   if (this_link->prev)
1288     *prev = this_link->prev->data;
1289   else
1290     *prev = g_list_last (all_panes)->data;
1291
1292   g_list_free (all_panes);
1293 }
1294
1295 static gboolean
1296 gtk_paned_move_handle (GtkPaned      *paned,
1297                        GtkScrollType  scroll)
1298 {
1299   if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1300     {
1301       gint old_position;
1302       gint new_position;
1303       
1304       enum {
1305         SINGLE_STEP_SIZE = 1,
1306         PAGE_STEP_SIZE   = 75
1307       };
1308       
1309       old_position = gtk_paned_get_position (paned);
1310       
1311       switch (scroll)
1312         {
1313         case GTK_SCROLL_STEP_LEFT:
1314         case GTK_SCROLL_STEP_UP:
1315         case GTK_SCROLL_STEP_BACKWARD:
1316           new_position = old_position - SINGLE_STEP_SIZE;
1317           break;
1318           
1319         case GTK_SCROLL_STEP_RIGHT:
1320         case GTK_SCROLL_STEP_DOWN:
1321         case GTK_SCROLL_STEP_FORWARD:
1322           new_position = old_position + SINGLE_STEP_SIZE;
1323           break;
1324           
1325         case GTK_SCROLL_PAGE_LEFT:
1326         case GTK_SCROLL_PAGE_UP:
1327         case GTK_SCROLL_PAGE_BACKWARD:
1328           new_position = old_position - PAGE_STEP_SIZE;
1329           break;
1330           
1331         case GTK_SCROLL_PAGE_RIGHT:
1332         case GTK_SCROLL_PAGE_DOWN:
1333         case GTK_SCROLL_PAGE_FORWARD:
1334           new_position = old_position + PAGE_STEP_SIZE;
1335           break;
1336           
1337         case GTK_SCROLL_START:
1338           new_position = paned->min_position;
1339           break;
1340           
1341         case GTK_SCROLL_END:
1342           new_position = paned->max_position;
1343           break;
1344           
1345         default:
1346           new_position = old_position;
1347           break;
1348         }
1349       
1350       new_position = CLAMP (new_position, paned->min_position, paned->max_position);
1351       
1352       if (old_position != new_position)
1353         gtk_paned_set_position (paned, new_position);
1354
1355       return TRUE;
1356     }
1357
1358   return FALSE;
1359 }
1360
1361 static void
1362 gtk_paned_restore_focus (GtkPaned *paned)
1363 {
1364   if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1365     {
1366       if (paned->priv->saved_focus &&
1367           GTK_WIDGET_SENSITIVE (paned->priv->saved_focus))
1368         {
1369           gtk_widget_grab_focus (paned->priv->saved_focus);
1370         }
1371       else
1372         {
1373           /* the saved focus is somehow not available for focusing,
1374            * try
1375            *   1) tabbing into the paned widget
1376            * if that didn't work,
1377            *   2) unset focus for the window if there is one
1378            */
1379           
1380           if (!gtk_widget_child_focus (GTK_WIDGET (paned), GTK_DIR_TAB_FORWARD))
1381             {
1382               GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1383               
1384               if (GTK_IS_WINDOW (toplevel))
1385                 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1386             }
1387         }
1388       
1389       gtk_paned_set_saved_focus (paned, NULL);
1390       gtk_paned_set_first_paned (paned, NULL);
1391     }
1392 }
1393
1394 static gboolean
1395 gtk_paned_accept_position (GtkPaned *paned)
1396 {
1397   if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1398     {
1399       paned->original_position = -1;
1400       gtk_paned_restore_focus (paned);
1401
1402       return TRUE;
1403     }
1404
1405   return FALSE;
1406 }
1407
1408
1409 static gboolean
1410 gtk_paned_cancel_position (GtkPaned *paned)
1411 {
1412   if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1413     {
1414       if (paned->original_position != -1)
1415         {
1416           gtk_paned_set_position (paned, paned->original_position);
1417           paned->original_position = -1;
1418         }
1419
1420       gtk_paned_restore_focus (paned);
1421       return TRUE;
1422     }
1423
1424   return FALSE;
1425 }
1426
1427 static gboolean
1428 gtk_paned_cycle_handle_focus (GtkPaned *paned,
1429                               gboolean  reversed)
1430 {
1431   GtkPaned *next, *prev;
1432   
1433   if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1434     {
1435       GtkPaned *focus = NULL;
1436
1437       if (!paned->priv->first_paned)
1438         {
1439           /* The first_pane has disappeared. As an ad-hoc solution,
1440            * we make the currently focused paned the first_paned. To the
1441            * user this will seem like the paned cycling has been reset.
1442            */
1443           
1444           gtk_paned_set_first_paned (paned, paned);
1445         }
1446       
1447       gtk_paned_find_neighbours (paned, &next, &prev);
1448
1449       if (reversed && prev &&
1450           prev != paned && paned != paned->priv->first_paned)
1451         {
1452           focus = prev;
1453         }
1454       else if (!reversed && next &&
1455                next != paned && next != paned->priv->first_paned)
1456         {
1457           focus = next;
1458         }
1459       else
1460         {
1461           gtk_paned_accept_position (paned);
1462           return TRUE;
1463         }
1464
1465       g_assert (focus);
1466       
1467       gtk_paned_set_saved_focus (focus, paned->priv->saved_focus);
1468       gtk_paned_set_first_paned (focus, paned->priv->first_paned);
1469       
1470       gtk_paned_set_saved_focus (paned, NULL);
1471       gtk_paned_set_first_paned (paned, NULL);
1472       
1473       gtk_widget_grab_focus (GTK_WIDGET (focus));
1474       
1475       if (!gtk_widget_is_focus (GTK_WIDGET (paned)))
1476         {
1477           paned->original_position = -1;
1478           focus->original_position = gtk_paned_get_position (focus);
1479         }
1480     }
1481   else
1482     {
1483       GtkContainer *container = GTK_CONTAINER (paned);
1484       GtkPaned *focus;
1485       GtkPaned *first;
1486       GtkPaned *prev, *next;
1487       GtkWidget *toplevel;
1488
1489       gtk_paned_find_neighbours (paned, &next, &prev);
1490
1491       if (container->focus_child == paned->child1)
1492         {
1493           if (reversed)
1494             {
1495               focus = prev;
1496               first = paned;
1497             }
1498           else
1499             {
1500               focus = paned;
1501               first = paned;
1502             }
1503         }
1504       else if (container->focus_child == paned->child2)
1505         {
1506           if (reversed)
1507             {
1508               focus = paned;
1509               first = next;
1510             }
1511           else
1512             {
1513               focus = next;
1514               first = next;
1515             }
1516         }
1517       else
1518         {
1519           /* Focus is not inside this paned, and we don't have focus.
1520            * Presumably this happened because the application wants us
1521            * to start keyboard navigating.
1522            */
1523           focus = paned;
1524
1525           if (reversed)
1526             first = paned;
1527           else
1528             first = next;
1529         }
1530
1531       toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1532
1533       if (GTK_IS_WINDOW (toplevel))
1534         gtk_paned_set_saved_focus (focus, GTK_WINDOW (toplevel)->focus_widget);
1535       gtk_paned_set_first_paned (focus, first);
1536       focus->original_position = gtk_paned_get_position (focus); 
1537
1538       gtk_widget_grab_focus (GTK_WIDGET (focus));
1539    }
1540   
1541   return TRUE;
1542 }
1543
1544 static gboolean
1545 gtk_paned_toggle_handle_focus (GtkPaned *paned)
1546 {
1547   /* This function/signal has the wrong name. It is called when you
1548    * press Tab or Shift-Tab and what we do is act as if
1549    * the user pressed Return and then Tab or Shift-Tab
1550    */
1551   if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1552     gtk_paned_accept_position (paned);
1553
1554   return FALSE;
1555 }