1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 3 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-1999. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
26 * Simple composite widget to provide vertical scrolling, based
27 * on GtkRange widget code.
28 * Modified by the Sylpheed Team and others 2003
33 #include "claws-features.h"
39 #include "gtkvscrollbutton.h"
42 #define SCROLL_TIMER_LENGTH 20
43 #define SCROLL_INITIAL_DELAY 100 /* must hold button this long before ... */
44 #define SCROLL_LATER_DELAY 20 /* ... it starts repeating at this rate */
45 #define SCROLL_DELAY_LENGTH 300
53 static void gtk_vscrollbutton_class_init(GtkVScrollbuttonClass * klass);
54 static void gtk_vscrollbutton_init(GtkVScrollbutton * vscrollbutton);
56 GType gtk_vscrollbutton_get_type (void);
57 GtkWidget *gtk_vscrollbutton_new (GtkAdjustment *adjustment);
59 static gint gtk_vscrollbutton_button_release (GtkWidget *widget,
60 GdkEventButton *event,
61 GtkVScrollbutton *scrollbutton);
63 static void gtk_vscrollbutton_set_adjustment (GtkVScrollbutton *scrollbutton,
64 GtkAdjustment *adjustment);
66 static gint gtk_vscrollbutton_button_press (GtkWidget *widget,
67 GdkEventButton *event,
68 GtkVScrollbutton *scrollbutton);
70 static gint gtk_vscrollbutton_button_release (GtkWidget *widget,
71 GdkEventButton *event,
72 GtkVScrollbutton *scrollbutton);
74 gint gtk_vscrollbutton_scroll (GtkVScrollbutton *scrollbutton);
76 static gboolean gtk_vscrollbutton_timer_1st_time(GtkVScrollbutton *scrollbutton);
78 static void gtk_vscrollbutton_add_timer (GtkVScrollbutton *scrollbutton);
80 static void gtk_vscrollbutton_remove_timer (GtkVScrollbutton *scrollbutton);
82 static gboolean gtk_real_vscrollbutton_timer (GtkVScrollbutton *scrollbutton);
84 static void gtk_vscrollbutton_set_sensitivity (GtkAdjustment *adjustment,
85 GtkVScrollbutton *scrollbutton);
87 GType gtk_vscrollbutton_get_type(void)
89 static GType vscrollbutton_type = 0;
91 if (!vscrollbutton_type) {
92 static const GTypeInfo vscrollbutton_info = {
93 sizeof (GtkVScrollbuttonClass),
96 (GBaseFinalizeFunc) NULL,
98 (GClassInitFunc) gtk_vscrollbutton_class_init,
99 (GClassFinalizeFunc) NULL,
100 NULL, /* class_data */
102 sizeof (GtkVScrollbutton),
104 (GInstanceInitFunc) gtk_vscrollbutton_init,
107 vscrollbutton_type = g_type_register_static (GTK_TYPE_VBOX, "GtkVScrollbutton", &vscrollbutton_info, (GTypeFlags)0);
110 return vscrollbutton_type;
113 static void gtk_vscrollbutton_class_init(GtkVScrollbuttonClass *class)
117 static GdkCursor *hand_cursor = NULL;
119 static gboolean vscroll_visi_notify(GtkWidget *widget,
120 GdkEventVisibility *event,
123 gdk_window_set_cursor(gtk_widget_get_window(widget), hand_cursor);
127 static gboolean vscroll_leave_notify(GtkWidget *widget,
128 GdkEventCrossing *event,
131 gdk_window_set_cursor(gtk_widget_get_window(widget), NULL);
135 static gboolean vscroll_enter_notify(GtkWidget *widget,
136 GdkEventCrossing *event,
139 gdk_window_set_cursor(gtk_widget_get_window(widget), hand_cursor);
144 static void gtk_vscrollbutton_init(GtkVScrollbutton *scrollbutton)
149 hand_cursor = gdk_cursor_new(GDK_HAND2);
151 scrollbutton->upbutton = gtk_event_box_new();
152 scrollbutton->downbutton = gtk_event_box_new();
153 arrow = gtk_arrow_new(GTK_ARROW_UP, GTK_SHADOW_NONE);
154 gtk_widget_show(arrow);
155 gtk_container_add(GTK_CONTAINER(scrollbutton->upbutton), arrow);
156 gtk_widget_set_size_request(scrollbutton->upbutton, -1, 16);
157 arrow = gtk_arrow_new(GTK_ARROW_DOWN, GTK_SHADOW_NONE);
158 gtk_widget_show(arrow);
159 gtk_container_add(GTK_CONTAINER(scrollbutton->downbutton), arrow);
160 gtk_widget_set_size_request(scrollbutton->downbutton, -1, 16);
161 gtkut_widget_set_can_focus(scrollbutton->upbutton, FALSE);
162 gtkut_widget_set_can_focus(scrollbutton->downbutton, FALSE);
163 gtk_widget_show(scrollbutton->downbutton);
164 gtk_widget_show(scrollbutton->upbutton);
166 g_signal_connect(G_OBJECT(scrollbutton->upbutton), "motion-notify-event",
167 G_CALLBACK(vscroll_visi_notify), NULL);
168 g_signal_connect(G_OBJECT(scrollbutton->upbutton), "leave-notify-event",
169 G_CALLBACK(vscroll_leave_notify), NULL);
170 g_signal_connect(G_OBJECT(scrollbutton->upbutton), "enter-notify-event",
171 G_CALLBACK(vscroll_enter_notify), NULL);
172 g_signal_connect(G_OBJECT(scrollbutton->downbutton), "motion-notify-event",
173 G_CALLBACK(vscroll_visi_notify), NULL);
174 g_signal_connect(G_OBJECT(scrollbutton->downbutton), "leave-notify-event",
175 G_CALLBACK(vscroll_leave_notify), NULL);
176 g_signal_connect(G_OBJECT(scrollbutton->downbutton), "enter-notify-event",
177 G_CALLBACK(vscroll_enter_notify), NULL);
179 g_signal_connect(G_OBJECT(scrollbutton->upbutton),
180 "button_press_event",
181 G_CALLBACK(gtk_vscrollbutton_button_press),
183 g_signal_connect(G_OBJECT(scrollbutton->downbutton),
184 "button_press_event",
185 G_CALLBACK(gtk_vscrollbutton_button_press),
187 g_signal_connect(G_OBJECT(scrollbutton->upbutton),
188 "button_release_event",
190 (gtk_vscrollbutton_button_release), scrollbutton);
191 g_signal_connect(G_OBJECT(scrollbutton->downbutton),
192 "button_release_event",
194 (gtk_vscrollbutton_button_release), scrollbutton);
195 gtk_box_pack_start(GTK_BOX(&scrollbutton->vbox),
196 scrollbutton->upbutton, TRUE, TRUE, 0);
197 gtk_box_pack_end(GTK_BOX(&scrollbutton->vbox),
198 scrollbutton->downbutton, TRUE, TRUE, 0);
199 scrollbutton->timer = 0;
202 GtkWidget *gtk_vscrollbutton_new(GtkAdjustment *adjustment)
204 GtkWidget *vscrollbutton;
205 vscrollbutton = g_object_new (gtk_vscrollbutton_get_type(),
207 gtk_vscrollbutton_set_adjustment(GTK_VSCROLLBUTTON(vscrollbutton),
209 g_signal_connect(G_OBJECT(GTK_VSCROLLBUTTON(vscrollbutton)->adjustment),
212 (gtk_vscrollbutton_set_sensitivity), vscrollbutton);
213 g_signal_connect(G_OBJECT(GTK_VSCROLLBUTTON(vscrollbutton)->adjustment),
216 (gtk_vscrollbutton_set_sensitivity), vscrollbutton);
217 return vscrollbutton;
221 void gtk_vscrollbutton_set_adjustment(GtkVScrollbutton *scrollbutton,
222 GtkAdjustment *adjustment)
224 cm_return_if_fail(scrollbutton != NULL);
225 cm_return_if_fail(GTK_IS_VSCROLLBUTTON(scrollbutton));
229 GTK_ADJUSTMENT(gtk_adjustment_new(0.0, 0.0, 0.0, 0.0, 0.0, 0.0));
231 cm_return_if_fail(GTK_IS_ADJUSTMENT(adjustment));
233 if (scrollbutton->adjustment != adjustment) {
234 if (scrollbutton->adjustment) {
235 g_signal_handlers_disconnect_matched(scrollbutton->adjustment,
238 (gpointer) scrollbutton);
239 g_object_unref(G_OBJECT(scrollbutton->adjustment));
242 scrollbutton->adjustment = adjustment;
243 g_object_ref(G_OBJECT(adjustment));
244 g_object_ref_sink (G_OBJECT(adjustment));
248 static gint gtk_vscrollbutton_button_press(GtkWidget *widget,
249 GdkEventButton *event,
250 GtkVScrollbutton *scrollbutton)
252 if (!gtk_widget_has_focus(widget))
253 gtk_widget_grab_focus(widget);
255 if (scrollbutton->button == 0) {
256 gtk_grab_add(widget);
257 scrollbutton->button = event->button;
259 if (widget == scrollbutton->downbutton)
260 scrollbutton->scroll_type = GTK_SCROLL_STEP_FORWARD;
262 scrollbutton->scroll_type = GTK_SCROLL_STEP_BACKWARD;
263 gtk_vscrollbutton_scroll(scrollbutton);
264 gtk_vscrollbutton_add_timer(scrollbutton);
270 static gint gtk_vscrollbutton_button_release(GtkWidget *widget,
271 GdkEventButton *event,
272 GtkVScrollbutton *scrollbutton)
274 if (!gtk_widget_has_focus(widget))
275 gtk_widget_grab_focus(widget);
277 if (scrollbutton->button == event->button) {
278 gtk_grab_remove(widget);
280 scrollbutton->button = 0;
281 gtk_vscrollbutton_remove_timer(scrollbutton);
282 gtk_vscrollbutton_set_sensitivity(scrollbutton->adjustment, scrollbutton);
287 gboolean gtk_vscrollbutton_scroll(GtkVScrollbutton *scrollbutton)
295 cm_return_val_if_fail(scrollbutton != NULL, FALSE);
296 cm_return_val_if_fail(GTK_IS_VSCROLLBUTTON(scrollbutton), FALSE);
298 new_value = value = gtk_adjustment_get_value(scrollbutton->adjustment);
301 switch (scrollbutton->scroll_type) {
303 case GTK_SCROLL_STEP_BACKWARD:
304 new_value = value - gtk_adjustment_get_step_increment(scrollbutton->adjustment);
305 bound = gtk_adjustment_get_lower(scrollbutton->adjustment);
306 if (new_value <= bound) {
309 scrollbutton->timer = 0;
313 case GTK_SCROLL_STEP_FORWARD:
314 new_value = value + gtk_adjustment_get_step_increment(scrollbutton->adjustment);
315 bound = gtk_adjustment_get_upper(scrollbutton->adjustment);
316 page_size = gtk_adjustment_get_page_size(scrollbutton->adjustment);
317 if (new_value >= (bound - page_size)) {
318 new_value = bound - page_size;
320 scrollbutton->timer = 0;
329 if (new_value != value) {
330 gtk_adjustment_set_value(scrollbutton->adjustment, new_value);
331 g_signal_emit_by_name(G_OBJECT
332 (scrollbutton->adjustment),
334 gtk_widget_queue_resize(GTK_WIDGET(scrollbutton)); /* ensure resize */
341 gtk_vscrollbutton_timer_1st_time(GtkVScrollbutton *scrollbutton)
344 * If the real timeout function succeeds and the timeout is still set,
345 * replace it with a quicker one so successive scrolling goes faster.
347 g_object_ref(G_OBJECT(scrollbutton));
348 if (scrollbutton->timer) {
349 /* We explicitely remove ourselves here in the paranoia
350 * that due to things happening above in the callback
351 * above, we might have been removed, and another added.
353 g_source_remove(scrollbutton->timer);
354 scrollbutton->timer = g_timeout_add(SCROLL_LATER_DELAY,
356 gtk_real_vscrollbutton_timer,
359 g_object_unref(G_OBJECT(scrollbutton));
360 return FALSE; /* don't keep calling this function */
364 static void gtk_vscrollbutton_add_timer(GtkVScrollbutton *scrollbutton)
366 cm_return_if_fail(scrollbutton != NULL);
367 cm_return_if_fail(GTK_IS_VSCROLLBUTTON(scrollbutton));
369 if (!scrollbutton->timer) {
370 scrollbutton->need_timer = TRUE;
371 scrollbutton->timer = g_timeout_add(SCROLL_INITIAL_DELAY,
373 gtk_vscrollbutton_timer_1st_time,
378 static void gtk_vscrollbutton_remove_timer(GtkVScrollbutton *scrollbutton)
380 cm_return_if_fail(scrollbutton != NULL);
381 cm_return_if_fail(GTK_IS_VSCROLLBUTTON(scrollbutton));
383 if (scrollbutton->timer) {
384 g_source_remove(scrollbutton->timer);
385 scrollbutton->timer = 0;
387 scrollbutton->need_timer = FALSE;
390 static gboolean gtk_real_vscrollbutton_timer(GtkVScrollbutton *scrollbutton)
397 if (!scrollbutton->timer) {
399 if (scrollbutton->need_timer)
400 scrollbutton->timer =
401 g_timeout_add(SCROLL_TIMER_LENGTH,
402 (GSourceFunc) gtk_real_vscrollbutton_timer,
403 (gpointer) scrollbutton);
408 scrollbutton->need_timer = FALSE;
411 return_val = gtk_vscrollbutton_scroll(scrollbutton);
415 static void gtk_vscrollbutton_set_sensitivity (GtkAdjustment *adjustment,
416 GtkVScrollbutton *scrollbutton)
419 if (!gtk_widget_get_realized(GTK_WIDGET(scrollbutton))) return;
420 if (scrollbutton->button != 0) return; /* not while something is pressed */
422 value = gtk_adjustment_get_value(adjustment);
423 gtk_widget_set_sensitive(scrollbutton->upbutton,
424 (value > gtk_adjustment_get_lower(adjustment)));
425 gtk_widget_set_sensitive(scrollbutton->downbutton,
426 (value < (gtk_adjustment_get_upper(adjustment) -
427 gtk_adjustment_get_page_size(adjustment))));