AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
f9c0fc4fdd
gtk2/gtk/gtkeventcontrollerscroll.h

80 lines
3.6 KiB
C
Raw Normal View History

gtk: Add GtkEventControllerScroll This is a GtkEventController implementation to handle mouse scrolling. It handles both smooth and discrete events and offers a way for callers to tell their preference too, so smooth events shall be accumulated and coalesced on request. On capable devices, it can also emit ::scroll-begin and ::scroll-end enclosing all ::scroll events for a scroll operation. It also has builtin kinetic scrolling capabilities, reporting the initial velocity for both axes after ::scroll-end if requested.
2017-09-15 11:22:57 +00:00
/* GTK - The GIMP Toolkit
* Copyright (C) 2017, Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author(s): Carlos Garnacho <carlosg@gnome.org>
*/
#ifndef __GTK_EVENT_CONTROLLER_SCROLL_H__
#define __GTK_EVENT_CONTROLLER_SCROLL_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gdk/gdk.h>
#include <gtk/gtkeventcontroller.h>
G_BEGIN_DECLS
#define GTK_TYPE_EVENT_CONTROLLER_SCROLL (gtk_event_controller_scroll_get_type ())
#define GTK_EVENT_CONTROLLER_SCROLL(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_EVENT_CONTROLLER_SCROLL, GtkEventControllerScroll))
#define GTK_EVENT_CONTROLLER_SCROLL_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_EVENT_CONTROLLER_SCROLL, GtkEventControllerScrollClass))
#define GTK_IS_EVENT_CONTROLLER_SCROLL(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_EVENT_CONTROLLER_SCROLL))
#define GTK_IS_EVENT_CONTROLLER_SCROLL_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_EVENT_CONTROLLER_SCROLL))
#define GTK_EVENT_CONTROLLER_SCROLL_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_EVENT_CONTROLLER_SCROLL, GtkEventControllerScrollClass))
typedef struct _GtkEventControllerScroll GtkEventControllerScroll;
typedef struct _GtkEventControllerScrollClass GtkEventControllerScrollClass;
gtkeventcontrollerscroll: Add some docs
2017-12-01 23:18:07 +00:00
/**
* GtkEventControllerScrollFlags:
* @GTK_EVENT_CONTROLLER_SCROLL_NONE: Don't emit scroll.
* @GTK_EVENT_CONTROLLER_SCROLL_VERTICAL: Emit scroll with vertical deltas.
* @GTK_EVENT_CONTROLLER_SCROLL_HORIZONTAL: Emit scroll with horizontal deltas.
* @GTK_EVENT_CONTROLLER_SCROLL_DISCRETE: Only emit deltas that are multiples of 1.
eventcontrollerscroll: Convert docs
2021-03-01 06:37:08 +00:00
* @GTK_EVENT_CONTROLLER_SCROLL_KINETIC: Emit ::decelerate after continuous scroll finishes.
gtkeventcontrollerscroll: Add some docs
2017-12-01 23:18:07 +00:00
* @GTK_EVENT_CONTROLLER_SCROLL_BOTH_AXES: Emit scroll on both axes.
*
eventcontrollerscroll: Convert docs
2021-03-01 06:37:08 +00:00
* Describes the behavior of a `GtkEventControllerScroll`.
gtkeventcontrollerscroll: Add some docs
2017-12-01 23:18:07 +00:00
**/
gtk: Add GtkEventControllerScroll This is a GtkEventController implementation to handle mouse scrolling. It handles both smooth and discrete events and offers a way for callers to tell their preference too, so smooth events shall be accumulated and coalesced on request. On capable devices, it can also emit ::scroll-begin and ::scroll-end enclosing all ::scroll events for a scroll operation. It also has builtin kinetic scrolling capabilities, reporting the initial velocity for both axes after ::scroll-end if requested.
2017-09-15 11:22:57 +00:00
typedef enum {
GTK_EVENT_CONTROLLER_SCROLL_NONE = 0,
GTK_EVENT_CONTROLLER_SCROLL_VERTICAL = 1 << 0,
GTK_EVENT_CONTROLLER_SCROLL_HORIZONTAL = 1 << 1,
GTK_EVENT_CONTROLLER_SCROLL_DISCRETE = 1 << 2,
GTK_EVENT_CONTROLLER_SCROLL_KINETIC = 1 << 3,
GTK_EVENT_CONTROLLER_SCROLL_BOTH_AXES = (GTK_EVENT_CONTROLLER_SCROLL_VERTICAL | GTK_EVENT_CONTROLLER_SCROLL_HORIZONTAL),
} GtkEventControllerScrollFlags;
The big versioning cleanup Remove all the old 2.x and 3.x version annotations. GTK+ 4 is a new start, and from the perspective of a GTK+ 4 developer all these APIs have been around since the beginning.
2018-02-05 19:13:20 +00:00
GDK_AVAILABLE_IN_ALL
gtk: Add GtkEventControllerScroll This is a GtkEventController implementation to handle mouse scrolling. It handles both smooth and discrete events and offers a way for callers to tell their preference too, so smooth events shall be accumulated and coalesced on request. On capable devices, it can also emit ::scroll-begin and ::scroll-end enclosing all ::scroll events for a scroll operation. It also has builtin kinetic scrolling capabilities, reporting the initial velocity for both axes after ::scroll-end if requested.
2017-09-15 11:22:57 +00:00
GType gtk_event_controller_scroll_get_type (void) G_GNUC_CONST;
The big versioning cleanup Remove all the old 2.x and 3.x version annotations. GTK+ 4 is a new start, and from the perspective of a GTK+ 4 developer all these APIs have been around since the beginning.
2018-02-05 19:13:20 +00:00
GDK_AVAILABLE_IN_ALL
eventcontrollerscroll: Port to new API model
2018-03-10 17:29:57 +00:00
GtkEventController *gtk_event_controller_scroll_new (GtkEventControllerScrollFlags flags);
The big versioning cleanup Remove all the old 2.x and 3.x version annotations. GTK+ 4 is a new start, and from the perspective of a GTK+ 4 developer all these APIs have been around since the beginning.
2018-02-05 19:13:20 +00:00
GDK_AVAILABLE_IN_ALL
Fix some parameter name mismatches to make g-ir-scanner happier
2017-12-09 14:36:35 +00:00
void gtk_event_controller_scroll_set_flags (GtkEventControllerScroll *scroll,
gtk: Add GtkEventControllerScroll This is a GtkEventController implementation to handle mouse scrolling. It handles both smooth and discrete events and offers a way for callers to tell their preference too, so smooth events shall be accumulated and coalesced on request. On capable devices, it can also emit ::scroll-begin and ::scroll-end enclosing all ::scroll events for a scroll operation. It also has builtin kinetic scrolling capabilities, reporting the initial velocity for both axes after ::scroll-end if requested.
2017-09-15 11:22:57 +00:00
GtkEventControllerScrollFlags flags);
The big versioning cleanup Remove all the old 2.x and 3.x version annotations. GTK+ 4 is a new start, and from the perspective of a GTK+ 4 developer all these APIs have been around since the beginning.
2018-02-05 19:13:20 +00:00
GDK_AVAILABLE_IN_ALL
gtk: Add GtkEventControllerScroll This is a GtkEventController implementation to handle mouse scrolling. It handles both smooth and discrete events and offers a way for callers to tell their preference too, so smooth events shall be accumulated and coalesced on request. On capable devices, it can also emit ::scroll-begin and ::scroll-end enclosing all ::scroll events for a scroll operation. It also has builtin kinetic scrolling capabilities, reporting the initial velocity for both axes after ::scroll-end if requested.
2017-09-15 11:22:57 +00:00
GtkEventControllerScrollFlags
Fix some parameter name mismatches to make g-ir-scanner happier
2017-12-09 14:36:35 +00:00
gtk_event_controller_scroll_get_flags (GtkEventControllerScroll *scroll);
gtk: Add GtkEventControllerScroll This is a GtkEventController implementation to handle mouse scrolling. It handles both smooth and discrete events and offers a way for callers to tell their preference too, so smooth events shall be accumulated and coalesced on request. On capable devices, it can also emit ::scroll-begin and ::scroll-end enclosing all ::scroll events for a scroll operation. It also has builtin kinetic scrolling capabilities, reporting the initial velocity for both axes after ::scroll-end if requested.
2017-09-15 11:22:57 +00:00
gtkeventcontrollerscroll: Add scroll unit getter The scroll unit is accessible through gtk_event_controller_scroll_get_unit() after the "scroll" signal reception.
2022-02-21 15:23:24 +00:00
GDK_AVAILABLE_IN_4_8
GdkScrollUnit gtk_event_controller_scroll_get_unit (GtkEventControllerScroll *scroll);
gtk: Add GtkEventControllerScroll This is a GtkEventController implementation to handle mouse scrolling. It handles both smooth and discrete events and offers a way for callers to tell their preference too, so smooth events shall be accumulated and coalesced on request. On capable devices, it can also emit ::scroll-begin and ::scroll-end enclosing all ::scroll events for a scroll operation. It also has builtin kinetic scrolling capabilities, reporting the initial velocity for both axes after ::scroll-end if requested.
2017-09-15 11:22:57 +00:00
G_END_DECLS
#endif /* __GTK_EVENT_CONTROLLER_SCROLL_H__ */
Reference in New Issue Copy Permalink