1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2017, Red Hat, Inc.
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, see <http://www.gnu.org/licenses/>.
16  *
17  * Author(s): Carlos Garnacho <carlosg@gnome.org>
18  */
19 
20 #ifndef __GTK_EVENT_CONTROLLER_SCROLL_H__
21 #define __GTK_EVENT_CONTROLLER_SCROLL_H__
22 
23 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
24 #error "Only <gtk/gtk.h> can be included directly."
25 #endif
26 
27 #include <gdk/gdk.h>
28 #include <gtk/gtkeventcontroller.h>
29 
30 G_BEGIN_DECLS
31 
32 #define GTK_TYPE_EVENT_CONTROLLER_SCROLL         (gtk_event_controller_scroll_get_type ())
33 #define GTK_EVENT_CONTROLLER_SCROLL(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_EVENT_CONTROLLER_SCROLL, GtkEventControllerScroll))
34 #define GTK_EVENT_CONTROLLER_SCROLL_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_EVENT_CONTROLLER_SCROLL, GtkEventControllerScrollClass))
35 #define GTK_IS_EVENT_CONTROLLER_SCROLL(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_EVENT_CONTROLLER_SCROLL))
36 #define GTK_IS_EVENT_CONTROLLER_SCROLL_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_EVENT_CONTROLLER_SCROLL))
37 #define GTK_EVENT_CONTROLLER_SCROLL_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_EVENT_CONTROLLER_SCROLL, GtkEventControllerScrollClass))
38 
39 typedef struct _GtkEventControllerScroll GtkEventControllerScroll;
40 typedef struct _GtkEventControllerScrollClass GtkEventControllerScrollClass;
41 
42 /**
43  * GtkEventControllerScrollFlags:
44  * @GTK_EVENT_CONTROLLER_SCROLL_NONE: Don't emit scroll.
45  * @GTK_EVENT_CONTROLLER_SCROLL_VERTICAL: Emit scroll with vertical deltas.
46  * @GTK_EVENT_CONTROLLER_SCROLL_HORIZONTAL: Emit scroll with horizontal deltas.
47  * @GTK_EVENT_CONTROLLER_SCROLL_DISCRETE: Only emit deltas that are multiples of 1.
48  * @GTK_EVENT_CONTROLLER_SCROLL_KINETIC: Emit #GtkEventControllerScroll::decelerate
49  *   after continuous scroll finishes.
50  * @GTK_EVENT_CONTROLLER_SCROLL_BOTH_AXES: Emit scroll on both axes.
51  *
52  * Describes the behavior of a #GtkEventControllerScroll.
53  *
54  * Since: 3.24
55  **/
56 typedef enum {
57   GTK_EVENT_CONTROLLER_SCROLL_NONE       = 0,
58   GTK_EVENT_CONTROLLER_SCROLL_VERTICAL   = 1 << 0,
59   GTK_EVENT_CONTROLLER_SCROLL_HORIZONTAL = 1 << 1,
60   GTK_EVENT_CONTROLLER_SCROLL_DISCRETE   = 1 << 2,
61   GTK_EVENT_CONTROLLER_SCROLL_KINETIC    = 1 << 3,
62   GTK_EVENT_CONTROLLER_SCROLL_BOTH_AXES  = (GTK_EVENT_CONTROLLER_SCROLL_VERTICAL | GTK_EVENT_CONTROLLER_SCROLL_HORIZONTAL),
63 } GtkEventControllerScrollFlags;
64 
65 GDK_AVAILABLE_IN_3_24
66 GType               gtk_event_controller_scroll_get_type  (void) G_GNUC_CONST;
67 
68 GDK_AVAILABLE_IN_3_24
69 GtkEventController *gtk_event_controller_scroll_new (GtkWidget                     *widget,
70                                                      GtkEventControllerScrollFlags  flags);
71 GDK_AVAILABLE_IN_3_24
72 void                gtk_event_controller_scroll_set_flags (GtkEventControllerScroll      *controller,
73                                                            GtkEventControllerScrollFlags  flags);
74 GDK_AVAILABLE_IN_3_24
75 GtkEventControllerScrollFlags
76                     gtk_event_controller_scroll_get_flags (GtkEventControllerScroll      *controller);
77 
78 G_END_DECLS
79 
80 #endif /* __GTK_EVENT_CONTROLLER_SCROLL_H__ */
81