1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 * Copyright (C) 2001 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser 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 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * Modified by the GTK+ Team and others 1997-2004. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
34 #include "gtkmarshalers.h"
37 #include "gtkscrollbar.h"
39 #define SCROLL_INITIAL_DELAY 250 /* must hold button this long before ... */
40 #define SCROLL_LATER_DELAY 100 /* ... it starts repeating at this rate */
41 #define UPDATE_DELAY 300 /* Delay for queued update */
66 MOUSE_WIDGET /* inside widget but not in any of the above GUI elements */
69 struct _GtkRangeLayout
71 /* These are in widget->window coordinates */
72 GdkRectangle stepper_a;
73 GdkRectangle stepper_b;
74 GdkRectangle stepper_c;
75 GdkRectangle stepper_d;
76 /* The trough rectangle is the area the thumb can slide in, not the
82 /* Layout-related state */
84 MouseLocation mouse_location;
85 /* last mouse coords we got, or -1 if mouse is outside the range */
88 /* "grabbed" mouse location, OUTSIDE for no grab */
89 MouseLocation grab_location;
90 gint grab_button; /* 0 if none */
94 static void gtk_range_class_init (GtkRangeClass *klass);
95 static void gtk_range_init (GtkRange *range);
96 static void gtk_range_set_property (GObject *object,
100 static void gtk_range_get_property (GObject *object,
104 static void gtk_range_destroy (GtkObject *object);
105 static void gtk_range_finalize (GObject *object);
106 static void gtk_range_size_request (GtkWidget *widget,
107 GtkRequisition *requisition);
108 static void gtk_range_size_allocate (GtkWidget *widget,
109 GtkAllocation *allocation);
110 static void gtk_range_realize (GtkWidget *widget);
111 static void gtk_range_unrealize (GtkWidget *widget);
112 static void gtk_range_map (GtkWidget *widget);
113 static void gtk_range_unmap (GtkWidget *widget);
114 static gint gtk_range_expose (GtkWidget *widget,
115 GdkEventExpose *event);
116 static gint gtk_range_button_press (GtkWidget *widget,
117 GdkEventButton *event);
118 static gint gtk_range_button_release (GtkWidget *widget,
119 GdkEventButton *event);
120 static gint gtk_range_motion_notify (GtkWidget *widget,
121 GdkEventMotion *event);
122 static gint gtk_range_enter_notify (GtkWidget *widget,
123 GdkEventCrossing *event);
124 static gint gtk_range_leave_notify (GtkWidget *widget,
125 GdkEventCrossing *event);
126 static void gtk_range_grab_notify (GtkWidget *widget,
127 gboolean was_grabbed);
128 static void gtk_range_state_changed (GtkWidget *widget,
129 GtkStateType previous_state);
130 static gint gtk_range_scroll_event (GtkWidget *widget,
131 GdkEventScroll *event);
132 static void gtk_range_style_set (GtkWidget *widget,
133 GtkStyle *previous_style);
134 static void update_slider_position (GtkRange *range,
141 static void gtk_range_move_slider (GtkRange *range,
142 GtkScrollType scroll);
145 static void gtk_range_scroll (GtkRange *range,
146 GtkScrollType scroll);
147 static gboolean gtk_range_update_mouse_location (GtkRange *range);
148 static void gtk_range_calc_layout (GtkRange *range,
149 gdouble adjustment_value);
150 static void gtk_range_get_props (GtkRange *range,
154 gint *stepper_spacing,
155 gint *arrow_displacement_x,
156 gint *arrow_displacement_y);
157 static void gtk_range_calc_request (GtkRange *range,
161 gint stepper_spacing,
162 GdkRectangle *range_rect,
165 gint *slider_length_p);
166 static void gtk_range_adjustment_value_changed (GtkAdjustment *adjustment,
168 static void gtk_range_adjustment_changed (GtkAdjustment *adjustment,
170 static void gtk_range_add_step_timer (GtkRange *range,
172 static void gtk_range_remove_step_timer (GtkRange *range);
173 static void gtk_range_reset_update_timer (GtkRange *range);
174 static void gtk_range_remove_update_timer (GtkRange *range);
175 static GdkRectangle* get_area (GtkRange *range,
176 MouseLocation location);
177 static gboolean gtk_range_real_change_value (GtkRange *range,
178 GtkScrollType scroll,
181 static void gtk_range_update_value (GtkRange *range);
184 static GtkWidgetClass *parent_class = NULL;
185 static guint signals[LAST_SIGNAL];
189 gtk_range_get_type (void)
191 static GType range_type = 0;
195 static const GTypeInfo range_info =
197 sizeof (GtkRangeClass),
198 NULL, /* base_init */
199 NULL, /* base_finalize */
200 (GClassInitFunc) gtk_range_class_init,
201 NULL, /* class_finalize */
202 NULL, /* class_data */
205 (GInstanceInitFunc) gtk_range_init,
206 NULL, /* value_table */
209 range_type = g_type_register_static (GTK_TYPE_WIDGET, "GtkRange",
210 &range_info, G_TYPE_FLAG_ABSTRACT);
217 gtk_range_class_init (GtkRangeClass *class)
219 GObjectClass *gobject_class;
220 GtkObjectClass *object_class;
221 GtkWidgetClass *widget_class;
223 gobject_class = G_OBJECT_CLASS (class);
224 object_class = (GtkObjectClass*) class;
225 widget_class = (GtkWidgetClass*) class;
227 parent_class = g_type_class_peek_parent (class);
229 gobject_class->set_property = gtk_range_set_property;
230 gobject_class->get_property = gtk_range_get_property;
231 gobject_class->finalize = gtk_range_finalize;
232 object_class->destroy = gtk_range_destroy;
234 widget_class->size_request = gtk_range_size_request;
235 widget_class->size_allocate = gtk_range_size_allocate;
236 widget_class->realize = gtk_range_realize;
237 widget_class->unrealize = gtk_range_unrealize;
238 widget_class->map = gtk_range_map;
239 widget_class->unmap = gtk_range_unmap;
240 widget_class->expose_event = gtk_range_expose;
241 widget_class->button_press_event = gtk_range_button_press;
242 widget_class->button_release_event = gtk_range_button_release;
243 widget_class->motion_notify_event = gtk_range_motion_notify;
244 widget_class->scroll_event = gtk_range_scroll_event;
245 widget_class->enter_notify_event = gtk_range_enter_notify;
246 widget_class->leave_notify_event = gtk_range_leave_notify;
247 widget_class->grab_notify = gtk_range_grab_notify;
248 widget_class->state_changed = gtk_range_state_changed;
249 widget_class->style_set = gtk_range_style_set;
251 class->move_slider = gtk_range_move_slider;
252 class->change_value = gtk_range_real_change_value;
254 class->slider_detail = "slider";
255 class->stepper_detail = "stepper";
257 signals[VALUE_CHANGED] =
258 g_signal_new ("value_changed",
259 G_TYPE_FROM_CLASS (gobject_class),
261 G_STRUCT_OFFSET (GtkRangeClass, value_changed),
263 _gtk_marshal_NONE__NONE,
266 signals[ADJUST_BOUNDS] =
267 g_signal_new ("adjust_bounds",
268 G_TYPE_FROM_CLASS (gobject_class),
270 G_STRUCT_OFFSET (GtkRangeClass, adjust_bounds),
272 _gtk_marshal_VOID__DOUBLE,
276 signals[MOVE_SLIDER] =
277 g_signal_new ("move_slider",
278 G_TYPE_FROM_CLASS (gobject_class),
279 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
280 G_STRUCT_OFFSET (GtkRangeClass, move_slider),
282 _gtk_marshal_VOID__ENUM,
284 GTK_TYPE_SCROLL_TYPE);
287 * GtkRange::change-value:
288 * @range: the range that received the signal.
289 * @scroll: the type of scroll action that was performed.
290 * @value: the new value resulting from the scroll action.
291 * @returns: %TRUE to prevent other handlers from being invoked for the
292 * signal. %FALSE to propagate the signal further.
294 * The ::change-value signal is emitted when a scroll action is
295 * performed on a range. It allows an application to determine the
296 * type of scroll event that occurred and the resultant new value.
297 * The application can handle the event itself and return %TRUE to
298 * prevent further processing. Or, by returning %FALSE, it can pass
299 * the event to other handlers until the default GTK+ handler is
302 * The value parameter is unrounded. An application that overrides
303 * the ::change-value signal is responsible for clamping the value to
304 * the desired number of digits; the default GTK+ handler clamps the
305 * value based on @range->round_digits.
307 * It is not possible to use delayed update policies in an overridden
308 * ::change-value handler.
312 signals[CHANGE_VALUE] =
313 g_signal_new ("change_value",
314 G_TYPE_FROM_CLASS (gobject_class),
316 G_STRUCT_OFFSET (GtkRangeClass, change_value),
317 _gtk_boolean_handled_accumulator, NULL,
318 _gtk_marshal_BOOLEAN__ENUM_DOUBLE,
320 GTK_TYPE_SCROLL_TYPE,
323 g_object_class_install_property (gobject_class,
325 g_param_spec_enum ("update_policy",
327 P_("How the range should be updated on the screen"),
328 GTK_TYPE_UPDATE_TYPE,
329 GTK_UPDATE_CONTINUOUS,
332 g_object_class_install_property (gobject_class,
334 g_param_spec_object ("adjustment",
336 P_("The GtkAdjustment that contains the current value of this range object"),
338 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
340 g_object_class_install_property (gobject_class,
342 g_param_spec_boolean ("inverted",
344 P_("Invert direction slider moves to increase range value"),
348 gtk_widget_class_install_style_property (widget_class,
349 g_param_spec_int ("slider_width",
351 P_("Width of scrollbar or scale thumb"),
356 gtk_widget_class_install_style_property (widget_class,
357 g_param_spec_int ("trough_border",
359 P_("Spacing between thumb/steppers and outer trough bevel"),
364 gtk_widget_class_install_style_property (widget_class,
365 g_param_spec_int ("stepper_size",
367 P_("Length of step buttons at ends"),
372 gtk_widget_class_install_style_property (widget_class,
373 g_param_spec_int ("stepper_spacing",
374 P_("Stepper Spacing"),
375 P_("Spacing between step buttons and thumb"),
380 gtk_widget_class_install_style_property (widget_class,
381 g_param_spec_int ("arrow_displacement_x",
382 P_("Arrow X Displacement"),
383 P_("How far in the x direction to move the arrow when the button is depressed"),
388 gtk_widget_class_install_style_property (widget_class,
389 g_param_spec_int ("arrow_displacement_y",
390 P_("Arrow Y Displacement"),
391 P_("How far in the y direction to move the arrow when the button is depressed"),
399 gtk_range_set_property (GObject *object,
406 range = GTK_RANGE (object);
410 case PROP_UPDATE_POLICY:
411 gtk_range_set_update_policy (range, g_value_get_enum (value));
413 case PROP_ADJUSTMENT:
414 gtk_range_set_adjustment (range, g_value_get_object (value));
417 gtk_range_set_inverted (range, g_value_get_boolean (value));
420 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
426 gtk_range_get_property (GObject *object,
433 range = GTK_RANGE (object);
437 case PROP_UPDATE_POLICY:
438 g_value_set_enum (value, range->update_policy);
440 case PROP_ADJUSTMENT:
441 g_value_set_object (value, range->adjustment);
444 g_value_set_boolean (value, range->inverted);
447 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
453 gtk_range_init (GtkRange *range)
455 GTK_WIDGET_SET_FLAGS (range, GTK_NO_WINDOW);
457 range->adjustment = NULL;
458 range->update_policy = GTK_UPDATE_CONTINUOUS;
459 range->inverted = FALSE;
460 range->flippable = FALSE;
461 range->min_slider_size = 1;
462 range->has_stepper_a = FALSE;
463 range->has_stepper_b = FALSE;
464 range->has_stepper_c = FALSE;
465 range->has_stepper_d = FALSE;
466 range->need_recalc = TRUE;
467 range->round_digits = -1;
468 range->layout = g_new0 (GtkRangeLayout, 1);
469 range->layout->mouse_location = MOUSE_OUTSIDE;
470 range->layout->mouse_x = -1;
471 range->layout->mouse_y = -1;
472 range->layout->grab_location = MOUSE_OUTSIDE;
473 range->layout->grab_button = 0;
478 * gtk_range_get_adjustment:
479 * @range: a #GtkRange
481 * Get the #GtkAdjustment which is the "model" object for #GtkRange.
482 * See gtk_range_set_adjustment() for details.
483 * The return value does not have a reference added, so should not
486 * Return value: a #GtkAdjustment
489 gtk_range_get_adjustment (GtkRange *range)
491 g_return_val_if_fail (GTK_IS_RANGE (range), NULL);
493 if (!range->adjustment)
494 gtk_range_set_adjustment (range, NULL);
496 return range->adjustment;
500 * gtk_range_set_update_policy:
501 * @range: a #GtkRange
502 * @policy: update policy
504 * Sets the update policy for the range. #GTK_UPDATE_CONTINUOUS means that
505 * anytime the range slider is moved, the range value will change and the
506 * value_changed signal will be emitted. #GTK_UPDATE_DELAYED means that
507 * the value will be updated after a brief timeout where no slider motion
508 * occurs, so updates are spaced by a short time rather than
509 * continuous. #GTK_UPDATE_DISCONTINUOUS means that the value will only
510 * be updated when the user releases the button and ends the slider
515 gtk_range_set_update_policy (GtkRange *range,
516 GtkUpdateType policy)
518 g_return_if_fail (GTK_IS_RANGE (range));
520 if (range->update_policy != policy)
522 range->update_policy = policy;
523 g_object_notify (G_OBJECT (range), "update_policy");
528 * gtk_range_get_update_policy:
529 * @range: a #GtkRange
531 * Gets the update policy of @range. See gtk_range_set_update_policy().
533 * Return value: the current update policy
536 gtk_range_get_update_policy (GtkRange *range)
538 g_return_val_if_fail (GTK_IS_RANGE (range), GTK_UPDATE_CONTINUOUS);
540 return range->update_policy;
544 * gtk_range_set_adjustment:
545 * @range: a #GtkRange
546 * @adjustment: a #GtkAdjustment
548 * Sets the adjustment to be used as the "model" object for this range
549 * widget. The adjustment indicates the current range value, the
550 * minimum and maximum range values, the step/page increments used
551 * for keybindings and scrolling, and the page size. The page size
552 * is normally 0 for #GtkScale and nonzero for #GtkScrollbar, and
553 * indicates the size of the visible area of the widget being scrolled.
554 * The page size affects the size of the scrollbar slider.
558 gtk_range_set_adjustment (GtkRange *range,
559 GtkAdjustment *adjustment)
561 g_return_if_fail (GTK_IS_RANGE (range));
564 adjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
566 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
568 if (range->adjustment != adjustment)
570 if (range->adjustment)
572 g_signal_handlers_disconnect_by_func (range->adjustment,
573 gtk_range_adjustment_changed,
575 g_signal_handlers_disconnect_by_func (range->adjustment,
576 gtk_range_adjustment_value_changed,
578 g_object_unref (range->adjustment);
581 range->adjustment = adjustment;
582 g_object_ref (adjustment);
583 gtk_object_sink (GTK_OBJECT (adjustment));
585 g_signal_connect (adjustment, "changed",
586 G_CALLBACK (gtk_range_adjustment_changed),
588 g_signal_connect (adjustment, "value_changed",
589 G_CALLBACK (gtk_range_adjustment_value_changed),
592 gtk_range_adjustment_changed (adjustment, range);
593 g_object_notify (G_OBJECT (range), "adjustment");
598 * gtk_range_set_inverted:
599 * @range: a #GtkRange
600 * @setting: %TRUE to invert the range
602 * Ranges normally move from lower to higher values as the
603 * slider moves from top to bottom or left to right. Inverted
604 * ranges have higher values at the top or on the right rather than
605 * on the bottom or left.
609 gtk_range_set_inverted (GtkRange *range,
612 g_return_if_fail (GTK_IS_RANGE (range));
614 setting = setting != FALSE;
616 if (setting != range->inverted)
618 range->inverted = setting;
619 g_object_notify (G_OBJECT (range), "inverted");
620 gtk_widget_queue_resize (GTK_WIDGET (range));
625 * gtk_range_get_inverted:
626 * @range: a #GtkRange
628 * Gets the value set by gtk_range_set_inverted().
630 * Return value: %TRUE if the range is inverted
633 gtk_range_get_inverted (GtkRange *range)
635 g_return_val_if_fail (GTK_IS_RANGE (range), FALSE);
637 return range->inverted;
641 * gtk_range_set_increments:
642 * @range: a #GtkRange
646 * Sets the step and page sizes for the range.
647 * The step size is used when the user clicks the #GtkScrollbar
648 * arrows or moves #GtkScale via arrow keys. The page size
649 * is used for example when moving via Page Up or Page Down keys.
653 gtk_range_set_increments (GtkRange *range,
657 g_return_if_fail (GTK_IS_RANGE (range));
659 range->adjustment->step_increment = step;
660 range->adjustment->page_increment = page;
662 gtk_adjustment_changed (range->adjustment);
666 * gtk_range_set_range:
667 * @range: a #GtkRange
668 * @min: minimum range value
669 * @max: maximum range value
671 * Sets the allowable values in the #GtkRange, and clamps the range
672 * value to be between @min and @max. (If the range has a non-zero
673 * page size, it is clamped between @min and @max - page-size.)
676 gtk_range_set_range (GtkRange *range,
682 g_return_if_fail (GTK_IS_RANGE (range));
683 g_return_if_fail (min < max);
685 range->adjustment->lower = min;
686 range->adjustment->upper = max;
688 value = CLAMP (range->adjustment->value,
689 range->adjustment->lower,
690 (range->adjustment->upper - range->adjustment->page_size));
692 gtk_adjustment_set_value (range->adjustment, value);
693 gtk_adjustment_changed (range->adjustment);
697 * gtk_range_set_value:
698 * @range: a #GtkRange
699 * @value: new value of the range
701 * Sets the current value of the range; if the value is outside the
702 * minimum or maximum range values, it will be clamped to fit inside
703 * them. The range emits the "value_changed" signal if the value
708 gtk_range_set_value (GtkRange *range,
711 g_return_if_fail (GTK_IS_RANGE (range));
713 value = CLAMP (value, range->adjustment->lower,
714 (range->adjustment->upper - range->adjustment->page_size));
716 gtk_adjustment_set_value (range->adjustment, value);
720 * gtk_range_get_value:
721 * @range: a #GtkRange
723 * Gets the current value of the range.
725 * Return value: current value of the range.
728 gtk_range_get_value (GtkRange *range)
730 g_return_val_if_fail (GTK_IS_RANGE (range), 0.0);
732 return range->adjustment->value;
736 should_invert (GtkRange *range)
738 if (range->orientation == GTK_ORIENTATION_HORIZONTAL)
740 (range->inverted && !range->flippable) ||
741 (range->inverted && range->flippable && gtk_widget_get_direction (GTK_WIDGET (range)) == GTK_TEXT_DIR_LTR) ||
742 (!range->inverted && range->flippable && gtk_widget_get_direction (GTK_WIDGET (range)) == GTK_TEXT_DIR_RTL);
744 return range->inverted;
748 gtk_range_finalize (GObject *object)
750 GtkRange *range = GTK_RANGE (object);
752 g_free (range->layout);
754 (* G_OBJECT_CLASS (parent_class)->finalize) (object);
758 gtk_range_destroy (GtkObject *object)
760 GtkRange *range = GTK_RANGE (object);
762 gtk_range_remove_step_timer (range);
763 gtk_range_remove_update_timer (range);
765 if (range->adjustment)
767 g_signal_handlers_disconnect_by_func (range->adjustment,
768 gtk_range_adjustment_changed,
770 g_signal_handlers_disconnect_by_func (range->adjustment,
771 gtk_range_adjustment_value_changed,
773 g_object_unref (range->adjustment);
774 range->adjustment = NULL;
777 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
781 gtk_range_size_request (GtkWidget *widget,
782 GtkRequisition *requisition)
785 gint slider_width, stepper_size, trough_border, stepper_spacing;
786 GdkRectangle range_rect;
789 range = GTK_RANGE (widget);
791 gtk_range_get_props (range,
792 &slider_width, &stepper_size, &trough_border, &stepper_spacing,
795 gtk_range_calc_request (range,
796 slider_width, stepper_size, trough_border, stepper_spacing,
797 &range_rect, &border, NULL, NULL);
799 requisition->width = range_rect.width + border.left + border.right;
800 requisition->height = range_rect.height + border.top + border.bottom;
804 gtk_range_size_allocate (GtkWidget *widget,
805 GtkAllocation *allocation)
809 range = GTK_RANGE (widget);
811 widget->allocation = *allocation;
813 range->need_recalc = TRUE;
814 gtk_range_calc_layout (range, range->adjustment->value);
816 if (GTK_WIDGET_REALIZED (range))
817 gdk_window_move_resize (range->event_window,
818 widget->allocation.x,
819 widget->allocation.y,
820 widget->allocation.width,
821 widget->allocation.height);
825 gtk_range_realize (GtkWidget *widget)
828 GdkWindowAttr attributes;
829 gint attributes_mask;
831 range = GTK_RANGE (widget);
833 gtk_range_calc_layout (range, range->adjustment->value);
835 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
837 widget->window = gtk_widget_get_parent_window (widget);
838 g_object_ref (widget->window);
840 attributes.window_type = GDK_WINDOW_CHILD;
841 attributes.x = widget->allocation.x;
842 attributes.y = widget->allocation.y;
843 attributes.width = widget->allocation.width;
844 attributes.height = widget->allocation.height;
845 attributes.wclass = GDK_INPUT_ONLY;
846 attributes.event_mask = gtk_widget_get_events (widget);
847 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
848 GDK_BUTTON_RELEASE_MASK |
849 GDK_ENTER_NOTIFY_MASK |
850 GDK_LEAVE_NOTIFY_MASK |
851 GDK_POINTER_MOTION_MASK |
852 GDK_POINTER_MOTION_HINT_MASK);
854 attributes_mask = GDK_WA_X | GDK_WA_Y;
856 range->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
857 &attributes, attributes_mask);
858 gdk_window_set_user_data (range->event_window, range);
860 widget->style = gtk_style_attach (widget->style, widget->window);
864 gtk_range_unrealize (GtkWidget *widget)
866 GtkRange *range = GTK_RANGE (widget);
868 gtk_range_remove_step_timer (range);
869 gtk_range_remove_update_timer (range);
871 gdk_window_set_user_data (range->event_window, NULL);
872 gdk_window_destroy (range->event_window);
873 range->event_window = NULL;
875 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
876 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
880 gtk_range_map (GtkWidget *widget)
882 GtkRange *range = GTK_RANGE (widget);
884 g_return_if_fail (GTK_IS_RANGE (widget));
886 gdk_window_show (range->event_window);
888 GTK_WIDGET_CLASS (parent_class)->map (widget);
892 gtk_range_unmap (GtkWidget *widget)
894 GtkRange *range = GTK_RANGE (widget);
896 g_return_if_fail (GTK_IS_RANGE (widget));
898 gdk_window_hide (range->event_window);
900 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
904 draw_stepper (GtkRange *range,
906 GtkArrowType arrow_type,
911 GtkStateType state_type;
912 GtkShadowType shadow_type;
913 GdkRectangle intersection;
914 GtkWidget *widget = GTK_WIDGET (range);
921 /* More to get the right clip region than for efficiency */
922 if (!gdk_rectangle_intersect (area, rect, &intersection))
925 intersection.x += widget->allocation.x;
926 intersection.y += widget->allocation.y;
928 if (!GTK_WIDGET_IS_SENSITIVE (range))
929 state_type = GTK_STATE_INSENSITIVE;
931 state_type = GTK_STATE_ACTIVE;
933 state_type = GTK_STATE_PRELIGHT;
935 state_type = GTK_STATE_NORMAL;
938 shadow_type = GTK_SHADOW_IN;
940 shadow_type = GTK_SHADOW_OUT;
942 gtk_paint_box (widget->style,
944 state_type, shadow_type,
945 &intersection, widget,
946 GTK_RANGE_GET_CLASS (range)->stepper_detail,
947 widget->allocation.x + rect->x,
948 widget->allocation.y + rect->y,
952 arrow_width = rect->width / 2;
953 arrow_height = rect->height / 2;
954 arrow_x = widget->allocation.x + rect->x + (rect->width - arrow_width) / 2;
955 arrow_y = widget->allocation.y + rect->y + (rect->height - arrow_height) / 2;
959 gint arrow_displacement_x;
960 gint arrow_displacement_y;
962 gtk_range_get_props (GTK_RANGE (widget), NULL, NULL, NULL, NULL,
963 &arrow_displacement_x, &arrow_displacement_y);
965 arrow_x += arrow_displacement_x;
966 arrow_y += arrow_displacement_y;
969 gtk_paint_arrow (widget->style,
971 state_type, shadow_type,
972 &intersection, widget,
973 GTK_RANGE_GET_CLASS (range)->stepper_detail,
976 arrow_x, arrow_y, arrow_width, arrow_height);
980 gtk_range_expose (GtkWidget *widget,
981 GdkEventExpose *event)
986 GdkRectangle expose_area; /* Relative to widget->allocation */
988 gint focus_line_width = 0;
989 gint focus_padding = 0;
991 range = GTK_RANGE (widget);
993 if (GTK_WIDGET_CAN_FOCUS (range))
995 gtk_widget_style_get (GTK_WIDGET (range),
996 "focus-line-width", &focus_line_width,
997 "focus-padding", &focus_padding,
1001 expose_area = event->area;
1002 expose_area.x -= widget->allocation.x;
1003 expose_area.y -= widget->allocation.y;
1005 gtk_range_calc_layout (range, range->adjustment->value);
1007 sensitive = GTK_WIDGET_IS_SENSITIVE (widget);
1009 /* Just to be confusing, we draw the trough for the whole
1010 * range rectangle, not the trough rectangle (the trough
1011 * rectangle is just for hit detection)
1013 /* The gdk_rectangle_intersect is more to get the right
1014 * clip region (limited to range_rect) than for efficiency
1016 if (gdk_rectangle_intersect (&expose_area, &range->range_rect,
1019 area.x += widget->allocation.x;
1020 area.y += widget->allocation.y;
1022 gtk_paint_box (widget->style,
1024 sensitive ? GTK_STATE_ACTIVE : GTK_STATE_INSENSITIVE,
1026 &area, GTK_WIDGET(range), "trough",
1027 widget->allocation.x + range->range_rect.x + focus_line_width + focus_padding,
1028 widget->allocation.y + range->range_rect.y + focus_line_width + focus_padding,
1029 range->range_rect.width - 2 * (focus_line_width + focus_padding),
1030 range->range_rect.height - 2 * (focus_line_width + focus_padding));
1034 GTK_WIDGET_HAS_FOCUS (range))
1035 gtk_paint_focus (widget->style, widget->window, GTK_WIDGET_STATE (widget),
1036 &area, widget, "trough",
1037 widget->allocation.x + range->range_rect.x,
1038 widget->allocation.y + range->range_rect.y,
1039 range->range_rect.width,
1040 range->range_rect.height);
1044 state = GTK_STATE_INSENSITIVE;
1045 else if (range->layout->mouse_location == MOUSE_SLIDER)
1046 state = GTK_STATE_PRELIGHT;
1048 state = GTK_STATE_NORMAL;
1050 if (gdk_rectangle_intersect (&expose_area,
1051 &range->layout->slider,
1054 area.x += widget->allocation.x;
1055 area.y += widget->allocation.y;
1057 gtk_paint_slider (widget->style,
1063 GTK_RANGE_GET_CLASS (range)->slider_detail,
1064 widget->allocation.x + range->layout->slider.x,
1065 widget->allocation.y + range->layout->slider.y,
1066 range->layout->slider.width,
1067 range->layout->slider.height,
1068 range->orientation);
1071 if (range->has_stepper_a)
1072 draw_stepper (range, &range->layout->stepper_a,
1073 range->orientation == GTK_ORIENTATION_VERTICAL ? GTK_ARROW_UP : GTK_ARROW_LEFT,
1074 range->layout->grab_location == MOUSE_STEPPER_A,
1075 range->layout->mouse_location == MOUSE_STEPPER_A,
1078 if (range->has_stepper_b)
1079 draw_stepper (range, &range->layout->stepper_b,
1080 range->orientation == GTK_ORIENTATION_VERTICAL ? GTK_ARROW_DOWN : GTK_ARROW_RIGHT,
1081 range->layout->grab_location == MOUSE_STEPPER_B,
1082 range->layout->mouse_location == MOUSE_STEPPER_B,
1085 if (range->has_stepper_c)
1086 draw_stepper (range, &range->layout->stepper_c,
1087 range->orientation == GTK_ORIENTATION_VERTICAL ? GTK_ARROW_UP : GTK_ARROW_LEFT,
1088 range->layout->grab_location == MOUSE_STEPPER_C,
1089 range->layout->mouse_location == MOUSE_STEPPER_C,
1092 if (range->has_stepper_d)
1093 draw_stepper (range, &range->layout->stepper_d,
1094 range->orientation == GTK_ORIENTATION_VERTICAL ? GTK_ARROW_DOWN : GTK_ARROW_RIGHT,
1095 range->layout->grab_location == MOUSE_STEPPER_D,
1096 range->layout->mouse_location == MOUSE_STEPPER_D,
1103 range_grab_add (GtkRange *range,
1104 MouseLocation location,
1107 /* we don't actually gtk_grab, since a button is down */
1109 gtk_grab_add (GTK_WIDGET (range));
1111 range->layout->grab_location = location;
1112 range->layout->grab_button = button;
1114 if (gtk_range_update_mouse_location (range))
1115 gtk_widget_queue_draw (GTK_WIDGET (range));
1119 range_grab_remove (GtkRange *range)
1121 gtk_grab_remove (GTK_WIDGET (range));
1123 range->layout->grab_location = MOUSE_OUTSIDE;
1124 range->layout->grab_button = 0;
1126 if (gtk_range_update_mouse_location (range))
1127 gtk_widget_queue_draw (GTK_WIDGET (range));
1130 static GtkScrollType
1131 range_get_scroll_for_grab (GtkRange *range)
1135 invert = should_invert (range);
1136 switch (range->layout->grab_location)
1138 /* Backward stepper */
1139 case MOUSE_STEPPER_A:
1140 case MOUSE_STEPPER_C:
1141 switch (range->layout->grab_button)
1144 return invert ? GTK_SCROLL_STEP_FORWARD : GTK_SCROLL_STEP_BACKWARD;
1147 return invert ? GTK_SCROLL_PAGE_FORWARD : GTK_SCROLL_PAGE_BACKWARD;
1150 return invert ? GTK_SCROLL_END : GTK_SCROLL_START;
1155 /* Forward stepper */
1156 case MOUSE_STEPPER_B:
1157 case MOUSE_STEPPER_D:
1158 switch (range->layout->grab_button)
1161 return invert ? GTK_SCROLL_STEP_BACKWARD : GTK_SCROLL_STEP_FORWARD;
1164 return invert ? GTK_SCROLL_PAGE_BACKWARD : GTK_SCROLL_PAGE_FORWARD;
1167 return invert ? GTK_SCROLL_START : GTK_SCROLL_END;
1175 if (range->trough_click_forward)
1176 return GTK_SCROLL_PAGE_FORWARD;
1178 return GTK_SCROLL_PAGE_BACKWARD;
1188 return GTK_SCROLL_NONE;
1192 coord_to_value (GtkRange *range,
1198 if (range->orientation == GTK_ORIENTATION_VERTICAL)
1199 if (range->layout->trough.height == range->layout->slider.height)
1202 frac = ((coord - range->layout->trough.y) /
1203 (gdouble) (range->layout->trough.height - range->layout->slider.height));
1205 if (range->layout->trough.width == range->layout->slider.width)
1208 frac = ((coord - range->layout->trough.x) /
1209 (gdouble) (range->layout->trough.width - range->layout->slider.width));
1211 if (should_invert (range))
1214 value = range->adjustment->lower +
1215 frac * (range->adjustment->upper - range->adjustment->lower - range->adjustment->page_size);
1221 gtk_range_button_press (GtkWidget *widget,
1222 GdkEventButton *event)
1224 GtkRange *range = GTK_RANGE (widget);
1226 if (!GTK_WIDGET_HAS_FOCUS (widget))
1227 gtk_widget_grab_focus (widget);
1229 /* ignore presses when we're already doing something else. */
1230 if (range->layout->grab_location != MOUSE_OUTSIDE)
1233 range->layout->mouse_x = event->x;
1234 range->layout->mouse_y = event->y;
1235 if (gtk_range_update_mouse_location (range))
1236 gtk_widget_queue_draw (widget);
1238 if (range->layout->mouse_location == MOUSE_TROUGH &&
1241 /* button 1 steps by page increment, as with button 2 on a stepper
1243 GtkScrollType scroll;
1244 gdouble click_value;
1246 click_value = coord_to_value (range,
1247 range->orientation == GTK_ORIENTATION_VERTICAL ?
1248 event->y : event->x);
1250 range->trough_click_forward = click_value > range->adjustment->value;
1251 range_grab_add (range, MOUSE_TROUGH, event->button);
1253 scroll = range_get_scroll_for_grab (range);
1255 gtk_range_add_step_timer (range, scroll);
1259 else if ((range->layout->mouse_location == MOUSE_STEPPER_A ||
1260 range->layout->mouse_location == MOUSE_STEPPER_B ||
1261 range->layout->mouse_location == MOUSE_STEPPER_C ||
1262 range->layout->mouse_location == MOUSE_STEPPER_D) &&
1263 (event->button == 1 || event->button == 2 || event->button == 3))
1265 GdkRectangle *stepper_area;
1266 GtkScrollType scroll;
1268 range_grab_add (range, range->layout->mouse_location, event->button);
1270 stepper_area = get_area (range, range->layout->mouse_location);
1271 gtk_widget_queue_draw_area (widget,
1272 widget->allocation.x + stepper_area->x,
1273 widget->allocation.y + stepper_area->y,
1274 stepper_area->width,
1275 stepper_area->height);
1277 scroll = range_get_scroll_for_grab (range);
1278 if (scroll != GTK_SCROLL_NONE)
1279 gtk_range_add_step_timer (range, scroll);
1283 else if ((range->layout->mouse_location == MOUSE_TROUGH &&
1284 event->button == 2) ||
1285 range->layout->mouse_location == MOUSE_SLIDER)
1287 gboolean need_value_update = FALSE;
1289 /* Any button can be used to drag the slider, but you can start
1290 * dragging the slider with a trough click using button 2;
1291 * On button 2 press, we warp the slider to mouse position,
1292 * then begin the slider drag.
1294 if (event->button == 2)
1296 gdouble slider_low_value, slider_high_value, new_value;
1299 coord_to_value (range,
1300 range->orientation == GTK_ORIENTATION_VERTICAL ?
1301 event->y : event->x);
1303 coord_to_value (range,
1304 range->orientation == GTK_ORIENTATION_VERTICAL ?
1305 event->y - range->layout->slider.height :
1306 event->x - range->layout->slider.width);
1308 /* compute new value for warped slider */
1309 new_value = slider_low_value + (slider_high_value - slider_low_value) / 2;
1311 /* recalc slider, so we can set slide_initial_slider_position
1314 range->need_recalc = TRUE;
1315 gtk_range_calc_layout (range, new_value);
1317 /* defer adjustment updates to update_slider_position() in order
1318 * to keep pixel quantisation
1320 need_value_update = TRUE;
1323 if (range->orientation == GTK_ORIENTATION_VERTICAL)
1325 range->slide_initial_slider_position = range->layout->slider.y;
1326 range->slide_initial_coordinate = event->y;
1330 range->slide_initial_slider_position = range->layout->slider.x;
1331 range->slide_initial_coordinate = event->x;
1334 if (need_value_update)
1335 update_slider_position (range, event->x, event->y);
1337 range_grab_add (range, MOUSE_SLIDER, event->button);
1345 /* During a slide, move the slider as required given new mouse position */
1347 update_slider_position (GtkRange *range,
1356 if (range->orientation == GTK_ORIENTATION_VERTICAL)
1357 delta = mouse_y - range->slide_initial_coordinate;
1359 delta = mouse_x - range->slide_initial_coordinate;
1361 c = range->slide_initial_slider_position + delta;
1363 new_value = coord_to_value (range, c);
1365 g_signal_emit (range, signals[CHANGE_VALUE], 0, GTK_SCROLL_JUMP, new_value,
1369 static void stop_scrolling (GtkRange *range)
1371 range_grab_remove (range);
1372 gtk_range_remove_step_timer (range);
1373 /* Flush any pending discontinuous/delayed updates */
1374 gtk_range_update_value (range);
1376 /* Just be lazy about this, if we scrolled it will all redraw anyway,
1377 * so no point optimizing the button deactivate case
1379 gtk_widget_queue_draw (GTK_WIDGET (range));
1383 gtk_range_button_release (GtkWidget *widget,
1384 GdkEventButton *event)
1386 GtkRange *range = GTK_RANGE (widget);
1388 if (event->window == range->event_window)
1390 range->layout->mouse_x = event->x;
1391 range->layout->mouse_y = event->y;
1395 gdk_window_get_pointer (range->event_window,
1396 &range->layout->mouse_x,
1397 &range->layout->mouse_y,
1401 if (range->layout->grab_button == event->button)
1403 if (range->layout->grab_location == MOUSE_SLIDER)
1404 update_slider_position (range, range->layout->mouse_x, range->layout->mouse_y);
1406 stop_scrolling (range);
1415 * _gtk_range_get_wheel_delta:
1416 * @range: a #GtkRange
1417 * @direction: A #GdkScrollDirection
1419 * Returns a good step value for the mouse wheel.
1421 * Return value: A good step value for the mouse wheel.
1426 _gtk_range_get_wheel_delta (GtkRange *range,
1427 GdkScrollDirection direction)
1429 GtkAdjustment *adj = range->adjustment;
1432 if (GTK_IS_SCROLLBAR (range))
1433 delta = pow (adj->page_size, 2.0 / 3.0);
1435 delta = adj->step_increment * 2;
1437 if (direction == GDK_SCROLL_UP ||
1438 direction == GDK_SCROLL_LEFT)
1441 if (range->inverted)
1448 gtk_range_scroll_event (GtkWidget *widget,
1449 GdkEventScroll *event)
1451 GtkRange *range = GTK_RANGE (widget);
1453 if (GTK_WIDGET_REALIZED (range))
1455 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1459 delta = _gtk_range_get_wheel_delta (range, event->direction);
1461 g_signal_emit (range, signals[CHANGE_VALUE], 0,
1462 GTK_SCROLL_JUMP, adj->value + delta,
1465 /* Policy DELAYED makes sense with scroll events,
1466 * but DISCONTINUOUS doesn't, so we update immediately
1469 if (range->update_policy == GTK_UPDATE_DISCONTINUOUS)
1470 gtk_range_update_value (range);
1477 gtk_range_motion_notify (GtkWidget *widget,
1478 GdkEventMotion *event)
1483 range = GTK_RANGE (widget);
1485 gdk_window_get_pointer (range->event_window, &x, &y, NULL);
1487 range->layout->mouse_x = x;
1488 range->layout->mouse_y = y;
1490 if (gtk_range_update_mouse_location (range))
1491 gtk_widget_queue_draw (widget);
1493 if (range->layout->grab_location == MOUSE_SLIDER)
1494 update_slider_position (range, x, y);
1496 /* We handled the event if the mouse was in the range_rect */
1497 return range->layout->mouse_location != MOUSE_OUTSIDE;
1501 gtk_range_enter_notify (GtkWidget *widget,
1502 GdkEventCrossing *event)
1504 GtkRange *range = GTK_RANGE (widget);
1506 range->layout->mouse_x = event->x;
1507 range->layout->mouse_y = event->y;
1509 if (gtk_range_update_mouse_location (range))
1510 gtk_widget_queue_draw (widget);
1516 gtk_range_leave_notify (GtkWidget *widget,
1517 GdkEventCrossing *event)
1519 GtkRange *range = GTK_RANGE (widget);
1521 range->layout->mouse_x = -1;
1522 range->layout->mouse_y = -1;
1524 if (gtk_range_update_mouse_location (range))
1525 gtk_widget_queue_draw (widget);
1531 gtk_range_grab_notify (GtkWidget *widget,
1532 gboolean was_grabbed)
1535 stop_scrolling (GTK_RANGE (widget));
1539 gtk_range_state_changed (GtkWidget *widget,
1540 GtkStateType previous_state)
1542 if (!GTK_WIDGET_IS_SENSITIVE (widget))
1543 stop_scrolling (GTK_RANGE (widget));
1547 gtk_range_adjustment_changed (GtkAdjustment *adjustment,
1550 GtkRange *range = GTK_RANGE (data);
1552 range->need_recalc = TRUE;
1553 gtk_widget_queue_draw (GTK_WIDGET (range));
1555 /* Note that we don't round off to range->round_digits here.
1556 * that's because it's really broken to change a value
1557 * in response to a change signal on that value; round_digits
1558 * is therefore defined to be a filter on what the GtkRange
1559 * can input into the adjustment, not a filter that the GtkRange
1560 * will enforce on the adjustment.
1565 gtk_range_adjustment_value_changed (GtkAdjustment *adjustment,
1568 GtkRange *range = GTK_RANGE (data);
1570 range->need_recalc = TRUE;
1572 gtk_widget_queue_draw (GTK_WIDGET (range));
1573 /* This is so we don't lag the widget being scrolled. */
1574 if (GTK_WIDGET_REALIZED (range))
1575 gdk_window_process_updates (GTK_WIDGET (range)->window, FALSE);
1577 /* Note that we don't round off to range->round_digits here.
1578 * that's because it's really broken to change a value
1579 * in response to a change signal on that value; round_digits
1580 * is therefore defined to be a filter on what the GtkRange
1581 * can input into the adjustment, not a filter that the GtkRange
1582 * will enforce on the adjustment.
1585 g_signal_emit (range, signals[VALUE_CHANGED], 0);
1589 gtk_range_style_set (GtkWidget *widget,
1590 GtkStyle *previous_style)
1592 GtkRange *range = GTK_RANGE (widget);
1594 range->need_recalc = TRUE;
1596 (* GTK_WIDGET_CLASS (parent_class)->style_set) (widget, previous_style);
1600 step_back (GtkRange *range)
1605 newval = range->adjustment->value - range->adjustment->step_increment;
1606 g_signal_emit (range, signals[CHANGE_VALUE], 0,
1607 GTK_SCROLL_STEP_BACKWARD, newval, &handled);
1611 step_forward (GtkRange *range)
1616 newval = range->adjustment->value + range->adjustment->step_increment;
1617 g_signal_emit (range, signals[CHANGE_VALUE], 0,
1618 GTK_SCROLL_STEP_FORWARD, newval, &handled);
1623 page_back (GtkRange *range)
1628 newval = range->adjustment->value - range->adjustment->page_increment;
1629 g_signal_emit (range, signals[CHANGE_VALUE], 0,
1630 GTK_SCROLL_PAGE_BACKWARD, newval, &handled);
1634 page_forward (GtkRange *range)
1639 newval = range->adjustment->value + range->adjustment->page_increment;
1640 g_signal_emit (range, signals[CHANGE_VALUE], 0,
1641 GTK_SCROLL_PAGE_FORWARD, newval, &handled);
1645 scroll_begin (GtkRange *range)
1648 g_signal_emit (range, signals[CHANGE_VALUE], 0,
1649 GTK_SCROLL_START, range->adjustment->lower,
1654 scroll_end (GtkRange *range)
1659 newval = range->adjustment->upper - range->adjustment->page_size;
1660 g_signal_emit (range, signals[CHANGE_VALUE], 0, GTK_SCROLL_END, newval,
1665 gtk_range_scroll (GtkRange *range,
1666 GtkScrollType scroll)
1670 case GTK_SCROLL_STEP_LEFT:
1671 if (should_invert (range))
1672 step_forward (range);
1677 case GTK_SCROLL_STEP_UP:
1678 if (should_invert (range))
1679 step_forward (range);
1684 case GTK_SCROLL_STEP_RIGHT:
1685 if (should_invert (range))
1688 step_forward (range);
1691 case GTK_SCROLL_STEP_DOWN:
1692 if (should_invert (range))
1695 step_forward (range);
1698 case GTK_SCROLL_STEP_BACKWARD:
1702 case GTK_SCROLL_STEP_FORWARD:
1703 step_forward (range);
1706 case GTK_SCROLL_PAGE_LEFT:
1707 if (should_invert (range))
1708 page_forward (range);
1713 case GTK_SCROLL_PAGE_UP:
1714 if (should_invert (range))
1715 page_forward (range);
1720 case GTK_SCROLL_PAGE_RIGHT:
1721 if (should_invert (range))
1724 page_forward (range);
1727 case GTK_SCROLL_PAGE_DOWN:
1728 if (should_invert (range))
1731 page_forward (range);
1734 case GTK_SCROLL_PAGE_BACKWARD:
1738 case GTK_SCROLL_PAGE_FORWARD:
1739 page_forward (range);
1742 case GTK_SCROLL_START:
1743 scroll_begin (range);
1746 case GTK_SCROLL_END:
1750 case GTK_SCROLL_JUMP:
1751 /* Used by CList, range doesn't use it. */
1754 case GTK_SCROLL_NONE:
1760 gtk_range_move_slider (GtkRange *range,
1761 GtkScrollType scroll)
1763 gtk_range_scroll (range, scroll);
1765 /* Policy DELAYED makes sense with key events,
1766 * but DISCONTINUOUS doesn't, so we update immediately
1769 if (range->update_policy == GTK_UPDATE_DISCONTINUOUS)
1770 gtk_range_update_value (range);
1774 gtk_range_get_props (GtkRange *range,
1777 gint *trough_border,
1778 gint *stepper_spacing,
1779 gint *arrow_displacement_x,
1780 gint *arrow_displacement_y)
1782 GtkWidget *widget = GTK_WIDGET (range);
1783 gint tmp_slider_width, tmp_stepper_size, tmp_trough_border, tmp_stepper_spacing;
1784 gint tmp_arrow_displacement_x, tmp_arrow_displacement_y;
1786 gtk_widget_style_get (widget,
1787 "slider_width", &tmp_slider_width,
1788 "trough_border", &tmp_trough_border,
1789 "stepper_size", &tmp_stepper_size,
1790 "stepper_spacing", &tmp_stepper_spacing,
1791 "arrow_displacement_x", &tmp_arrow_displacement_x,
1792 "arrow_displacement_y", &tmp_arrow_displacement_y,
1795 if (GTK_WIDGET_CAN_FOCUS (range))
1797 gint focus_line_width;
1800 gtk_widget_style_get (GTK_WIDGET (range),
1801 "focus-line-width", &focus_line_width,
1802 "focus-padding", &focus_padding,
1805 tmp_trough_border += focus_line_width + focus_padding;
1809 *slider_width = tmp_slider_width;
1812 *trough_border = tmp_trough_border;
1815 *stepper_size = tmp_stepper_size;
1817 if (stepper_spacing)
1818 *stepper_spacing = tmp_stepper_spacing;
1820 if (arrow_displacement_x)
1821 *arrow_displacement_x = tmp_arrow_displacement_x;
1823 if (arrow_displacement_y)
1824 *arrow_displacement_y = tmp_arrow_displacement_y;
1827 #define POINT_IN_RECT(xcoord, ycoord, rect) \
1828 ((xcoord) >= (rect).x && \
1829 (xcoord) < ((rect).x + (rect).width) && \
1830 (ycoord) >= (rect).y && \
1831 (ycoord) < ((rect).y + (rect).height))
1833 /* Update mouse location, return TRUE if it changes */
1835 gtk_range_update_mouse_location (GtkRange *range)
1841 widget = GTK_WIDGET (range);
1843 old = range->layout->mouse_location;
1845 x = range->layout->mouse_x;
1846 y = range->layout->mouse_y;
1848 if (range->layout->grab_location != MOUSE_OUTSIDE)
1849 range->layout->mouse_location = range->layout->grab_location;
1850 else if (POINT_IN_RECT (x, y, range->layout->stepper_a))
1851 range->layout->mouse_location = MOUSE_STEPPER_A;
1852 else if (POINT_IN_RECT (x, y, range->layout->stepper_b))
1853 range->layout->mouse_location = MOUSE_STEPPER_B;
1854 else if (POINT_IN_RECT (x, y, range->layout->stepper_c))
1855 range->layout->mouse_location = MOUSE_STEPPER_C;
1856 else if (POINT_IN_RECT (x, y, range->layout->stepper_d))
1857 range->layout->mouse_location = MOUSE_STEPPER_D;
1858 else if (POINT_IN_RECT (x, y, range->layout->slider))
1859 range->layout->mouse_location = MOUSE_SLIDER;
1860 else if (POINT_IN_RECT (x, y, range->layout->trough))
1861 range->layout->mouse_location = MOUSE_TROUGH;
1862 else if (POINT_IN_RECT (x, y, widget->allocation))
1863 range->layout->mouse_location = MOUSE_WIDGET;
1865 range->layout->mouse_location = MOUSE_OUTSIDE;
1867 return old != range->layout->mouse_location;
1870 /* Clamp rect, border inside widget->allocation, such that we prefer
1871 * to take space from border not rect in all directions, and prefer to
1872 * give space to border over rect in one direction.
1875 clamp_dimensions (GtkWidget *widget,
1878 gboolean border_expands_horizontally)
1880 gint extra, shortage;
1882 g_return_if_fail (rect->x == 0);
1883 g_return_if_fail (rect->y == 0);
1884 g_return_if_fail (rect->width >= 0);
1885 g_return_if_fail (rect->height >= 0);
1889 extra = widget->allocation.width - border->left - border->right - rect->width;
1892 if (border_expands_horizontally)
1894 border->left += extra / 2;
1895 border->right += extra / 2 + extra % 2;
1899 rect->width += extra;
1903 /* See if we can fit rect, if not kill the border */
1904 shortage = rect->width - widget->allocation.width;
1907 rect->width = widget->allocation.width;
1908 /* lose the border */
1914 /* See if we can fit rect with borders */
1915 shortage = rect->width + border->left + border->right -
1916 widget->allocation.width;
1919 /* Shrink borders */
1920 border->left -= shortage / 2;
1921 border->right -= shortage / 2 + shortage % 2;
1927 extra = widget->allocation.height - border->top - border->bottom - rect->height;
1930 if (border_expands_horizontally)
1932 /* don't expand border vertically */
1933 rect->height += extra;
1937 border->top += extra / 2;
1938 border->bottom += extra / 2 + extra % 2;
1942 /* See if we can fit rect, if not kill the border */
1943 shortage = rect->height - widget->allocation.height;
1946 rect->height = widget->allocation.height;
1947 /* lose the border */
1953 /* See if we can fit rect with borders */
1954 shortage = rect->height + border->top + border->bottom -
1955 widget->allocation.height;
1958 /* Shrink borders */
1959 border->top -= shortage / 2;
1960 border->bottom -= shortage / 2 + shortage % 2;
1966 gtk_range_calc_request (GtkRange *range,
1970 gint stepper_spacing,
1971 GdkRectangle *range_rect,
1974 gint *slider_length_p)
1984 if (GTK_RANGE_GET_CLASS (range)->get_range_border)
1985 (* GTK_RANGE_GET_CLASS (range)->get_range_border) (range, border);
1988 if (range->has_stepper_a)
1990 if (range->has_stepper_b)
1992 if (range->has_stepper_c)
1994 if (range->has_stepper_d)
1997 slider_length = range->min_slider_size;
2002 /* We never expand to fill available space in the small dimension
2003 * (i.e. vertical scrollbars are always a fixed width)
2005 if (range->orientation == GTK_ORIENTATION_VERTICAL)
2007 range_rect->width = trough_border * 2 + slider_width;
2008 range_rect->height = stepper_size * n_steppers + stepper_spacing * 2 + trough_border * 2 + slider_length;
2012 range_rect->width = stepper_size * n_steppers + stepper_spacing * 2 + trough_border * 2 + slider_length;
2013 range_rect->height = trough_border * 2 + slider_width;
2017 *n_steppers_p = n_steppers;
2019 if (slider_length_p)
2020 *slider_length_p = slider_length;
2024 gtk_range_calc_layout (GtkRange *range,
2025 gdouble adjustment_value)
2027 gint slider_width, stepper_size, trough_border, stepper_spacing;
2031 GdkRectangle range_rect;
2032 GtkRangeLayout *layout;
2035 if (!range->need_recalc)
2038 /* If we have a too-small allocation, we prefer the steppers over
2039 * the trough/slider, probably the steppers are a more useful
2040 * feature in small spaces.
2042 * Also, we prefer to draw the range itself rather than the border
2043 * areas if there's a conflict, since the borders will be decoration
2044 * not controls. Though this depends on subclasses cooperating by
2045 * not drawing on range->range_rect.
2048 widget = GTK_WIDGET (range);
2049 layout = range->layout;
2051 gtk_range_get_props (range,
2052 &slider_width, &stepper_size, &trough_border, &stepper_spacing,
2055 gtk_range_calc_request (range,
2056 slider_width, stepper_size, trough_border, stepper_spacing,
2057 &range_rect, &border, &n_steppers, &slider_length);
2059 /* We never expand to fill available space in the small dimension
2060 * (i.e. vertical scrollbars are always a fixed width)
2062 if (range->orientation == GTK_ORIENTATION_VERTICAL)
2064 clamp_dimensions (widget, &range_rect, &border, TRUE);
2068 clamp_dimensions (widget, &range_rect, &border, FALSE);
2071 range_rect.x = border.left;
2072 range_rect.y = border.top;
2074 range->range_rect = range_rect;
2076 if (range->orientation == GTK_ORIENTATION_VERTICAL)
2078 gint stepper_width, stepper_height;
2080 /* Steppers are the width of the range, and stepper_size in
2081 * height, or if we don't have enough height, divided equally
2082 * among available space.
2084 stepper_width = range_rect.width - trough_border * 2;
2086 if (stepper_width < 1)
2087 stepper_width = range_rect.width; /* screw the trough border */
2089 if (n_steppers == 0)
2090 stepper_height = 0; /* avoid divide by n_steppers */
2092 stepper_height = MIN (stepper_size, (range_rect.height / n_steppers));
2096 layout->stepper_a.x = range_rect.x + trough_border;
2097 layout->stepper_a.y = range_rect.y + trough_border;
2099 if (range->has_stepper_a)
2101 layout->stepper_a.width = stepper_width;
2102 layout->stepper_a.height = stepper_height;
2106 layout->stepper_a.width = 0;
2107 layout->stepper_a.height = 0;
2112 layout->stepper_b.x = layout->stepper_a.x;
2113 layout->stepper_b.y = layout->stepper_a.y + layout->stepper_a.height;
2115 if (range->has_stepper_b)
2117 layout->stepper_b.width = stepper_width;
2118 layout->stepper_b.height = stepper_height;
2122 layout->stepper_b.width = 0;
2123 layout->stepper_b.height = 0;
2128 if (range->has_stepper_d)
2130 layout->stepper_d.width = stepper_width;
2131 layout->stepper_d.height = stepper_height;
2135 layout->stepper_d.width = 0;
2136 layout->stepper_d.height = 0;
2139 layout->stepper_d.x = layout->stepper_a.x;
2140 layout->stepper_d.y = range_rect.y + range_rect.height - layout->stepper_d.height - trough_border;
2144 if (range->has_stepper_c)
2146 layout->stepper_c.width = stepper_width;
2147 layout->stepper_c.height = stepper_height;
2151 layout->stepper_c.width = 0;
2152 layout->stepper_c.height = 0;
2155 layout->stepper_c.x = layout->stepper_a.x;
2156 layout->stepper_c.y = layout->stepper_d.y - layout->stepper_c.height;
2158 /* Now the trough is the remaining space between steppers B and C,
2161 layout->trough.x = range_rect.x;
2162 layout->trough.y = layout->stepper_b.y + layout->stepper_b.height;
2163 layout->trough.width = range_rect.width;
2164 layout->trough.height = layout->stepper_c.y - (layout->stepper_b.y + layout->stepper_b.height);
2166 /* Slider fits into the trough, with stepper_spacing on either side,
2167 * and the size/position based on the adjustment or fixed, depending.
2169 layout->slider.x = layout->trough.x + trough_border;
2170 layout->slider.width = layout->trough.width - trough_border * 2;
2172 /* Compute slider position/length */
2174 gint y, bottom, top, height;
2176 top = layout->trough.y + stepper_spacing;
2177 bottom = layout->trough.y + layout->trough.height - stepper_spacing;
2179 /* slider height is the fraction (page_size /
2180 * total_adjustment_range) times the trough height in pixels
2183 if (range->adjustment->upper - range->adjustment->lower != 0)
2184 height = ((bottom - top) * (range->adjustment->page_size /
2185 (range->adjustment->upper - range->adjustment->lower)));
2187 height = range->min_slider_size;
2189 if (height < range->min_slider_size ||
2190 range->slider_size_fixed)
2191 height = range->min_slider_size;
2193 height = MIN (height, (layout->trough.height - stepper_spacing * 2));
2197 if (range->adjustment->upper - range->adjustment->lower - range->adjustment->page_size != 0)
2198 y += (bottom - top - height) * ((adjustment_value - range->adjustment->lower) /
2199 (range->adjustment->upper - range->adjustment->lower - range->adjustment->page_size));
2201 y = CLAMP (y, top, bottom);
2203 if (should_invert (range))
2204 y = bottom - (y - top + height);
2206 layout->slider.y = y;
2207 layout->slider.height = height;
2209 /* These are publically exported */
2210 range->slider_start = layout->slider.y;
2211 range->slider_end = layout->slider.y + layout->slider.height;
2216 gint stepper_width, stepper_height;
2218 /* Steppers are the height of the range, and stepper_size in
2219 * width, or if we don't have enough width, divided equally
2220 * among available space.
2222 stepper_height = range_rect.height - trough_border * 2;
2224 if (stepper_height < 1)
2225 stepper_height = range_rect.height; /* screw the trough border */
2227 if (n_steppers == 0)
2228 stepper_width = 0; /* avoid divide by n_steppers */
2230 stepper_width = MIN (stepper_size, (range_rect.width / n_steppers));
2234 layout->stepper_a.x = range_rect.x + trough_border;
2235 layout->stepper_a.y = range_rect.y + trough_border;
2237 if (range->has_stepper_a)
2239 layout->stepper_a.width = stepper_width;
2240 layout->stepper_a.height = stepper_height;
2244 layout->stepper_a.width = 0;
2245 layout->stepper_a.height = 0;
2250 layout->stepper_b.x = layout->stepper_a.x + layout->stepper_a.width;
2251 layout->stepper_b.y = layout->stepper_a.y;
2253 if (range->has_stepper_b)
2255 layout->stepper_b.width = stepper_width;
2256 layout->stepper_b.height = stepper_height;
2260 layout->stepper_b.width = 0;
2261 layout->stepper_b.height = 0;
2266 if (range->has_stepper_d)
2268 layout->stepper_d.width = stepper_width;
2269 layout->stepper_d.height = stepper_height;
2273 layout->stepper_d.width = 0;
2274 layout->stepper_d.height = 0;
2277 layout->stepper_d.x = range_rect.x + range_rect.width - layout->stepper_d.width - trough_border;
2278 layout->stepper_d.y = layout->stepper_a.y;
2283 if (range->has_stepper_c)
2285 layout->stepper_c.width = stepper_width;
2286 layout->stepper_c.height = stepper_height;
2290 layout->stepper_c.width = 0;
2291 layout->stepper_c.height = 0;
2294 layout->stepper_c.x = layout->stepper_d.x - layout->stepper_c.width;
2295 layout->stepper_c.y = layout->stepper_a.y;
2297 /* Now the trough is the remaining space between steppers B and C,
2300 layout->trough.x = layout->stepper_b.x + layout->stepper_b.width;
2301 layout->trough.y = range_rect.y;
2303 layout->trough.width = layout->stepper_c.x - (layout->stepper_b.x + layout->stepper_b.width);
2304 layout->trough.height = range_rect.height;
2306 /* Slider fits into the trough, with stepper_spacing on either side,
2307 * and the size/position based on the adjustment or fixed, depending.
2309 layout->slider.y = layout->trough.y + trough_border;
2310 layout->slider.height = layout->trough.height - trough_border * 2;
2312 /* Compute slider position/length */
2314 gint x, left, right, width;
2316 left = layout->trough.x + stepper_spacing;
2317 right = layout->trough.x + layout->trough.width - stepper_spacing;
2319 /* slider width is the fraction (page_size /
2320 * total_adjustment_range) times the trough width in pixels
2323 if (range->adjustment->upper - range->adjustment->lower != 0)
2324 width = ((right - left) * (range->adjustment->page_size /
2325 (range->adjustment->upper - range->adjustment->lower)));
2327 width = range->min_slider_size;
2329 if (width < range->min_slider_size ||
2330 range->slider_size_fixed)
2331 width = range->min_slider_size;
2333 width = MIN (width, (layout->trough.width - stepper_spacing * 2));
2337 if (range->adjustment->upper - range->adjustment->lower - range->adjustment->page_size != 0)
2338 x += (right - left - width) * ((adjustment_value - range->adjustment->lower) /
2339 (range->adjustment->upper - range->adjustment->lower - range->adjustment->page_size));
2341 x = CLAMP (x, left, right);
2343 if (should_invert (range))
2344 x = right - (x - left + width);
2346 layout->slider.x = x;
2347 layout->slider.width = width;
2349 /* These are publically exported */
2350 range->slider_start = layout->slider.x;
2351 range->slider_end = layout->slider.x + layout->slider.width;
2355 gtk_range_update_mouse_location (range);
2358 static GdkRectangle*
2359 get_area (GtkRange *range,
2360 MouseLocation location)
2364 case MOUSE_STEPPER_A:
2365 return &range->layout->stepper_a;
2366 case MOUSE_STEPPER_B:
2367 return &range->layout->stepper_b;
2368 case MOUSE_STEPPER_C:
2369 return &range->layout->stepper_c;
2370 case MOUSE_STEPPER_D:
2371 return &range->layout->stepper_d;
2373 return &range->layout->trough;
2375 return &range->layout->slider;
2381 g_warning (G_STRLOC": bug");
2386 gtk_range_real_change_value (GtkRange *range,
2387 GtkScrollType scroll,
2391 /* potentially adjust the bounds _before we clamp */
2392 g_signal_emit (range, signals[ADJUST_BOUNDS], 0, value);
2394 value = CLAMP (value, range->adjustment->lower,
2395 (range->adjustment->upper - range->adjustment->page_size));
2397 if (range->round_digits >= 0)
2401 /* This is just so darn lame. */
2402 g_snprintf (buffer, 128, "%0.*f",
2403 range->round_digits, value);
2404 sscanf (buffer, "%lf", &value);
2407 if (range->adjustment->value != value)
2409 range->need_recalc = TRUE;
2411 gtk_widget_queue_draw (GTK_WIDGET (range));
2413 switch (range->update_policy)
2415 case GTK_UPDATE_CONTINUOUS:
2416 gtk_adjustment_set_value (range->adjustment, value);
2419 /* Delayed means we update after a period of inactivity */
2420 case GTK_UPDATE_DELAYED:
2421 gtk_range_reset_update_timer (range);
2424 /* Discontinuous means we update on button release */
2425 case GTK_UPDATE_DISCONTINUOUS:
2426 /* don't emit value_changed signal */
2427 range->adjustment->value = value;
2428 range->update_pending = TRUE;
2436 gtk_range_update_value (GtkRange *range)
2438 gtk_range_remove_update_timer (range);
2440 if (range->update_pending)
2442 gtk_adjustment_value_changed (range->adjustment);
2444 range->update_pending = FALSE;
2448 struct _GtkRangeStepTimer
2455 second_timeout (gpointer data)
2459 GDK_THREADS_ENTER ();
2460 range = GTK_RANGE (data);
2461 gtk_range_scroll (range, range->timer->step);
2462 GDK_THREADS_LEAVE ();
2468 initial_timeout (gpointer data)
2472 GDK_THREADS_ENTER ();
2473 range = GTK_RANGE (data);
2474 range->timer->timeout_id =
2475 g_timeout_add (SCROLL_LATER_DELAY,
2478 GDK_THREADS_LEAVE ();
2485 gtk_range_add_step_timer (GtkRange *range,
2488 g_return_if_fail (range->timer == NULL);
2489 g_return_if_fail (step != GTK_SCROLL_NONE);
2491 range->timer = g_new (GtkRangeStepTimer, 1);
2493 range->timer->timeout_id =
2494 g_timeout_add (SCROLL_INITIAL_DELAY,
2497 range->timer->step = step;
2499 gtk_range_scroll (range, range->timer->step);
2503 gtk_range_remove_step_timer (GtkRange *range)
2507 if (range->timer->timeout_id != 0)
2508 g_source_remove (range->timer->timeout_id);
2510 g_free (range->timer);
2512 range->timer = NULL;
2517 update_timeout (gpointer data)
2521 GDK_THREADS_ENTER ();
2522 range = GTK_RANGE (data);
2523 gtk_range_update_value (range);
2524 range->update_timeout_id = 0;
2525 GDK_THREADS_LEAVE ();
2532 gtk_range_reset_update_timer (GtkRange *range)
2534 gtk_range_remove_update_timer (range);
2536 range->update_timeout_id = g_timeout_add (UPDATE_DELAY,
2542 gtk_range_remove_update_timer (GtkRange *range)
2544 if (range->update_timeout_id != 0)
2546 g_source_remove (range->update_timeout_id);
2547 range->update_timeout_id = 0;