1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 * Copyright (C) 1998 Elliot Lee
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the Free
17 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include "gtkhandlebox.h"
25 #include "gtksignal.h"
26 #include "gtkwindow.h"
29 #define DRAG_HANDLE_SIZE 10
31 #define GHOST_HEIGHT 3
32 #define SNAP_TOLERANCE 10
35 static void gtk_handle_box_class_init (GtkHandleBoxClass *klass);
36 static void gtk_handle_box_init (GtkHandleBox *handle_box);
37 static void gtk_handle_box_destroy (GtkObject *object);
38 static void gtk_handle_box_map (GtkWidget *widget);
39 static void gtk_handle_box_unmap (GtkWidget *widget);
40 static void gtk_handle_box_realize (GtkWidget *widget);
41 static void gtk_handle_box_unrealize (GtkWidget *widget);
42 static void gtk_handle_box_size_request (GtkWidget *widget,
43 GtkRequisition *requisition);
44 static void gtk_handle_box_size_allocate (GtkWidget *widget,
45 GtkAllocation *allocation);
46 static void gtk_handle_box_draw_ghost (GtkWidget *widget);
47 static void gtk_handle_box_paint (GtkWidget *widget,
48 GdkEventExpose *event,
50 static void gtk_handle_box_draw (GtkWidget *widget,
52 static gint gtk_handle_box_expose (GtkWidget *widget,
53 GdkEventExpose *event);
54 static gint gtk_handle_box_button_changed (GtkWidget *widget,
55 GdkEventButton *event);
56 static gint gtk_handle_box_motion (GtkWidget *widget,
57 GdkEventMotion *event);
58 static gint gtk_handle_box_delete_float (GtkWidget *widget,
63 static GtkBinClass *parent_class;
67 gtk_handle_box_get_type (void)
69 static guint handle_box_type = 0;
73 GtkTypeInfo handle_box_info =
76 sizeof (GtkHandleBox),
77 sizeof (GtkHandleBoxClass),
78 (GtkClassInitFunc) gtk_handle_box_class_init,
79 (GtkObjectInitFunc) gtk_handle_box_init,
84 handle_box_type = gtk_type_unique (gtk_bin_get_type (), &handle_box_info);
87 return handle_box_type;
91 gtk_handle_box_class_init (GtkHandleBoxClass *class)
93 GtkWidgetClass *widget_class;
94 GtkObjectClass *object_class;
96 object_class = (GtkObjectClass *) class;
97 widget_class = (GtkWidgetClass *) class;
99 parent_class = gtk_type_class (gtk_bin_get_type ());
101 object_class->destroy = gtk_handle_box_destroy;
103 widget_class->map = gtk_handle_box_map;
104 widget_class->unmap = gtk_handle_box_unmap;
105 widget_class->realize = gtk_handle_box_realize;
106 widget_class->unrealize = gtk_handle_box_unrealize;
107 widget_class->size_request = gtk_handle_box_size_request;
108 widget_class->size_allocate = gtk_handle_box_size_allocate;
109 widget_class->draw = gtk_handle_box_draw;
110 widget_class->expose_event = gtk_handle_box_expose;
111 widget_class->button_press_event = gtk_handle_box_button_changed;
112 widget_class->button_release_event = gtk_handle_box_button_changed;
113 widget_class->motion_notify_event = gtk_handle_box_motion;
117 gtk_handle_box_init (GtkHandleBox *handle_box)
119 GTK_WIDGET_UNSET_FLAGS (handle_box, GTK_NO_WINDOW);
120 GTK_WIDGET_SET_FLAGS (handle_box, GTK_BASIC); /* FIXME: are we really a basic widget? */
122 handle_box->steady_window = NULL;
123 handle_box->float_window = NULL;
124 handle_box->is_being_dragged = FALSE;
125 handle_box->is_onroot = FALSE;
126 handle_box->fleur_cursor = gdk_cursor_new (GDK_FLEUR);
127 handle_box->dragoff_x = 0;
128 handle_box->dragoff_y = 0;
129 handle_box->steady_x = 0;
130 handle_box->steady_x = 0;
134 gtk_handle_box_new (void)
136 return GTK_WIDGET (gtk_type_new (gtk_handle_box_get_type ()));
140 gtk_handle_box_destroy (GtkObject *object)
144 g_return_if_fail (object != NULL);
145 g_return_if_fail (GTK_IS_HANDLE_BOX (object));
147 hb = GTK_HANDLE_BOX (object);
149 gdk_cursor_destroy (hb->fleur_cursor);
151 if (GTK_OBJECT_CLASS (parent_class)->destroy)
152 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
156 gtk_handle_box_map (GtkWidget *widget)
161 g_return_if_fail (widget != NULL);
162 g_return_if_fail (GTK_IS_HANDLE_BOX (widget));
164 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
166 bin = GTK_BIN (widget);
167 hb = GTK_HANDLE_BOX (widget);
169 gdk_window_show (hb->steady_window);
170 gdk_window_show (widget->window);
173 && GTK_WIDGET_VISIBLE (bin->child)
174 && !GTK_WIDGET_MAPPED (bin->child))
175 gtk_widget_map (bin->child);
179 gtk_handle_box_unmap (GtkWidget *widget)
183 g_return_if_fail (widget != NULL);
184 g_return_if_fail (GTK_IS_HANDLE_BOX (widget));
186 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
188 hb = GTK_HANDLE_BOX (widget);
190 gdk_window_hide (widget->window);
191 gdk_window_hide (hb->steady_window);
195 gtk_handle_box_realize (GtkWidget *widget)
197 GdkWindowAttr attributes;
198 gint attributes_mask;
201 g_return_if_fail (widget != NULL);
202 g_return_if_fail (GTK_IS_HANDLE_BOX (widget));
204 hb = GTK_HANDLE_BOX (widget);
206 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
208 /* FIXME: we need a property that would tell the window manager not
209 * to put decoration on this window. This is not part of the ICCCM,
210 * so we'll have to define our own (a la KWM) and hack some window
211 * managers to support it.
214 hb->float_window = gtk_window_new (GTK_WINDOW_DIALOG);
215 gtk_window_set_policy (GTK_WINDOW (hb->float_window), FALSE, FALSE, TRUE);
216 gtk_container_border_width (GTK_CONTAINER (hb->float_window), 0);
217 gtk_signal_connect (GTK_OBJECT (hb->float_window), "delete_event",
218 (GtkSignalFunc) gtk_handle_box_delete_float,
221 attributes.x = widget->allocation.x;
222 attributes.y = widget->allocation.y;
223 attributes.width = widget->allocation.width;
224 attributes.height = widget->allocation.height;
225 attributes.window_type = GDK_WINDOW_CHILD;
226 attributes.wclass = GDK_INPUT_OUTPUT;
227 attributes.visual = gtk_widget_get_visual (widget);
228 attributes.colormap = gtk_widget_get_colormap (widget);
229 attributes.event_mask = (gtk_widget_get_events (widget)
230 | GDK_EXPOSURE_MASK);
232 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
234 hb->steady_window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
235 gdk_window_set_user_data (hb->steady_window, widget);
239 attributes.event_mask |= (GDK_BUTTON1_MOTION_MASK
240 | GDK_POINTER_MOTION_HINT_MASK
241 | GDK_BUTTON_PRESS_MASK
242 | GDK_BUTTON_RELEASE_MASK);
244 widget->window = gdk_window_new (hb->steady_window, &attributes, attributes_mask);
245 gdk_window_set_user_data (widget->window, widget);
247 widget->style = gtk_style_attach (widget->style, widget->window);
248 gtk_style_set_background (widget->style, hb->steady_window, GTK_STATE_NORMAL);
249 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
253 gtk_handle_box_unrealize (GtkWidget *widget)
257 g_return_if_fail (widget != NULL);
258 g_return_if_fail (GTK_IS_HANDLE_BOX (widget));
260 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
262 gtk_style_detach (widget->style);
264 hb = GTK_HANDLE_BOX (widget);
267 gdk_window_destroy (widget->window);
269 if (hb->steady_window)
270 gdk_window_destroy (hb->steady_window);
272 hb->steady_window = NULL;
273 widget->window = NULL;
275 /* FIXME: do we have to unref the float_window before destroying it? */
277 gtk_widget_destroy (hb->float_window);
278 hb->float_window = NULL;
282 gtk_handle_box_size_request (GtkWidget *widget,
283 GtkRequisition *requisition)
288 g_return_if_fail (widget != NULL);
289 g_return_if_fail (GTK_IS_HANDLE_BOX (widget));
290 g_return_if_fail (requisition != NULL);
292 bin = GTK_BIN (widget);
293 hb = GTK_HANDLE_BOX (widget);
295 requisition->width = DRAG_HANDLE_SIZE + GTK_CONTAINER (widget)->border_width * 2;
296 requisition->height = GTK_CONTAINER (widget)->border_width * 2;
298 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
300 gtk_widget_size_request (bin->child, &bin->child->requisition);
302 requisition->width += bin->child->requisition.width;
303 requisition->height += bin->child->requisition.height;
306 hb->real_requisition = *requisition;
308 requisition->height = GHOST_HEIGHT;
309 /* FIXME: Should also set requisition->width to a small value? */
313 gtk_handle_box_size_allocate (GtkWidget *widget,
314 GtkAllocation *allocation)
317 GtkAllocation child_allocation;
321 g_return_if_fail (widget != NULL);
322 g_return_if_fail (GTK_IS_HANDLE_BOX (widget));
323 g_return_if_fail (allocation != NULL);
325 widget->allocation = *allocation;
326 bin = GTK_BIN (widget);
327 hb = GTK_HANDLE_BOX (widget);
329 border_width = GTK_CONTAINER (widget)->border_width;
331 if (GTK_WIDGET_REALIZED (widget))
335 gdk_window_move_resize (hb->steady_window,
336 allocation->x + border_width,
337 allocation->y + border_width,
338 allocation->width - border_width * 2,
339 allocation->height - border_width * 2);
340 gdk_window_move_resize (widget->window,
343 allocation->width - border_width * 2,
344 allocation->height - border_width * 2);
348 gtk_widget_set_usize (hb->float_window,
349 hb->real_requisition.width,
350 hb->real_requisition.height);
351 gdk_window_resize (widget->window,
352 hb->real_requisition.width,
353 hb->real_requisition.height);
354 gdk_window_move_resize (hb->steady_window,
355 allocation->x + border_width,
356 allocation->y + border_width,
357 allocation->width - border_width * 2,
362 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
364 child_allocation.x = DRAG_HANDLE_SIZE;
365 child_allocation.y = 0;
369 child_allocation.width = hb->real_requisition.width - DRAG_HANDLE_SIZE;
370 child_allocation.height = hb->real_requisition.height;
374 child_allocation.width = allocation->width - DRAG_HANDLE_SIZE - border_width * 2;
375 child_allocation.height = allocation->height - border_width * 2;
378 gtk_widget_size_allocate (bin->child, &child_allocation);
383 gtk_handle_box_draw_ghost (GtkWidget *widget)
385 gtk_draw_hline (widget->style,
386 GTK_HANDLE_BOX (widget)->steady_window,
387 GTK_WIDGET_STATE (widget),
389 widget->allocation.width - GTK_CONTAINER (widget)->border_width * 2,
394 gtk_handle_box_paint (GtkWidget *widget,
395 GdkEventExpose *event,
400 GdkRectangle child_area;
401 GdkEventExpose child_event;
404 bin = GTK_BIN (widget);
405 hb = GTK_HANDLE_BOX (widget);
410 for (x = 1; x < DRAG_HANDLE_SIZE; x += 3)
411 gtk_draw_vline (widget->style,
413 GTK_WIDGET_STATE (widget),
414 0, hb->is_onroot ? hb->real_requisition.height : widget->allocation.height,
418 gtk_draw_shadow (widget->style,
420 GTK_WIDGET_STATE (widget),
423 hb->real_requisition.width,
424 hb->real_requisition.height);
426 gtk_draw_shadow (widget->style,
428 GTK_WIDGET_STATE (widget),
431 widget->allocation.width,
432 widget->allocation.height);
436 if (event == NULL) /* we were called from draw() */
438 if (gtk_widget_intersect (bin->child, area, &child_area))
439 gtk_widget_draw (bin->child, &child_area);
441 else /* we were called from expose() */
443 child_event = *event;
445 if (GTK_WIDGET_NO_WINDOW (bin->child)
446 && gtk_widget_intersect (bin->child, &event->area, &child_event.area))
447 gtk_widget_event (bin->child, (GdkEvent *) &child_event);
453 gtk_handle_box_draw (GtkWidget *widget,
456 GdkRectangle child_area;
459 g_return_if_fail (widget != NULL);
460 g_return_if_fail (GTK_IS_HANDLE_BOX (widget));
461 g_return_if_fail (area != NULL);
463 hb = GTK_HANDLE_BOX (widget);
465 if (GTK_WIDGET_DRAWABLE (widget))
469 /* The area parameter does not make sense in this case, so we
470 * repaint everything.
473 gtk_handle_box_draw_ghost (widget);
477 child_area.width = hb->real_requisition.width;
478 child_area.height = hb->real_requisition.height;
480 gtk_handle_box_paint (widget, NULL, &child_area);
483 gtk_handle_box_paint (widget, NULL, area);
488 gtk_handle_box_expose (GtkWidget *widget,
489 GdkEventExpose *event)
493 g_return_val_if_fail (widget != NULL, FALSE);
494 g_return_val_if_fail (GTK_IS_HANDLE_BOX (widget), FALSE);
495 g_return_val_if_fail (event != NULL, FALSE);
497 if (GTK_WIDGET_DRAWABLE (widget))
499 hb = GTK_HANDLE_BOX (widget);
501 if (event->window == hb->steady_window)
502 gtk_handle_box_draw_ghost (widget);
503 else if (event->window == widget->window)
504 gtk_handle_box_paint (widget, event, NULL);
511 gtk_handle_box_button_changed (GtkWidget *widget,
512 GdkEventButton *event)
516 g_return_val_if_fail (widget != NULL, FALSE);
517 g_return_val_if_fail (GTK_IS_HANDLE_BOX (widget), FALSE);
518 g_return_val_if_fail (event != NULL, FALSE);
520 hb = GTK_HANDLE_BOX (widget);
522 if (event->button == 1)
524 if ((event->type == GDK_BUTTON_PRESS) && (event->x < DRAG_HANDLE_SIZE))
526 hb->dragoff_x = event->x;
527 hb->dragoff_y = event->y;
529 gdk_window_get_origin (hb->steady_window, &hb->steady_x, &hb->steady_y);
531 hb->is_being_dragged = TRUE;
534 gtk_grab_add (widget);
535 while (gdk_pointer_grab (widget->window,
537 (GDK_BUTTON1_MOTION_MASK
538 | GDK_POINTER_MOTION_HINT_MASK
539 | GDK_BUTTON_RELEASE_MASK),
542 GDK_CURRENT_TIME) != 0); /* wait for success */
544 else if ((event->type == GDK_BUTTON_RELEASE) && hb->is_being_dragged)
546 gdk_pointer_ungrab (GDK_CURRENT_TIME);
547 gtk_grab_remove (widget);
548 hb->is_being_dragged = FALSE;
555 gtk_handle_box_motion (GtkWidget *widget,
556 GdkEventMotion *event)
562 g_return_val_if_fail (widget != NULL, FALSE);
563 g_return_val_if_fail (GTK_IS_HANDLE_BOX (widget), FALSE);
564 g_return_val_if_fail (event != NULL, FALSE);
566 hb = GTK_HANDLE_BOX (widget);
570 gdk_window_get_origin (widget->window, &ox, &oy);
571 gdk_window_get_pointer (widget->window, &newx, &newy, NULL);
577 newx = event->x_root;
578 newy = event->y_root;
581 newx -= hb->dragoff_x;
582 newy -= hb->dragoff_y;
584 if (hb->is_being_dragged)
586 newx = event->x_root - hb->dragoff_x;
587 newy = event->y_root - hb->dragoff_y;
589 if ((abs (hb->steady_x - newx) < SNAP_TOLERANCE)
590 && (abs (hb->steady_y - newy) < SNAP_TOLERANCE))
594 hb->is_onroot = FALSE;
596 gdk_pointer_ungrab (GDK_CURRENT_TIME);
598 gdk_window_reparent (widget->window, hb->steady_window, 0, 0);
600 gtk_widget_hide (hb->float_window);
602 while (gdk_pointer_grab (widget->window,
604 (GDK_BUTTON1_MOTION_MASK
605 | GDK_POINTER_MOTION_HINT_MASK
606 | GDK_BUTTON_RELEASE_MASK),
609 GDK_CURRENT_TIME) != 0); /* wait for success */
611 gtk_widget_queue_resize (widget);
618 gtk_widget_set_uposition (hb->float_window, newx, newy);
619 gdk_window_raise (hb->float_window->window);
623 hb->is_onroot = TRUE;
625 gdk_pointer_ungrab (GDK_CURRENT_TIME);
627 if (!GTK_WIDGET_REALIZED (hb->float_window))
628 gtk_widget_realize (hb->float_window);
630 gtk_widget_set_uposition (hb->float_window, newx, newy);
631 gdk_window_reparent (widget->window, hb->float_window->window, 0, 0);
632 gtk_widget_show (hb->float_window);
634 while (gdk_pointer_grab (widget->window,
636 (GDK_BUTTON1_MOTION_MASK
637 | GDK_POINTER_MOTION_HINT_MASK
638 | GDK_BUTTON_RELEASE_MASK),
641 GDK_CURRENT_TIME) != 0); /* wait for success */
643 gtk_widget_queue_resize (widget);
652 gtk_handle_box_delete_float (GtkWidget *widget,
658 g_return_val_if_fail (widget != NULL, FALSE);
659 g_return_val_if_fail (event != NULL, FALSE);
660 g_return_val_if_fail (data != NULL, FALSE);
661 g_return_val_if_fail (GTK_IS_HANDLE_BOX (data), FALSE);
663 hb = GTK_HANDLE_BOX (data);
665 hb->is_onroot = FALSE;
667 gdk_window_reparent (GTK_WIDGET (hb)->window, hb->steady_window, 0, 0);
668 gtk_widget_hide (hb->float_window);
669 gtk_widget_queue_resize (GTK_WIDGET (hb));