mutter/src/meta/barrier.h
Jasper St. Pierre 57c31a56f4 barrier: Add support for new barrier features in XInput 2.3
XInput 2.3 adds support for "barrier events", which let us know when
a pointer barrier has been hit, and when the pointer has stopped
hitting the barrier, and lets us "release" the barrier, temporarily
letting the pointer pass through the barrier. These features can be
combined to allow for certain pointer gestures, such as "pushing"
against the bottom of the screen, or stopping the pointer on monitor
edges while dragging slowly for increased edge precision.

This commit should allow graceful fallback if servers with
XInput 2.3 aren't supported.

https://bugzilla.gnome.org/show_bug.cgi?id=677215
2013-02-08 14:23:38 -05:00

92 lines
2.8 KiB
C

/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
#ifndef __META_BARRIER_H__
#define __META_BARRIER_H__
#include <glib-object.h>
#include <meta/display.h>
G_BEGIN_DECLS
#define META_TYPE_BARRIER (meta_barrier_get_type ())
#define META_BARRIER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), META_TYPE_BARRIER, MetaBarrier))
#define META_BARRIER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), META_TYPE_BARRIER, MetaBarrierClass))
#define META_IS_BARRIER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), META_TYPE_BARRIER))
#define META_IS_BARRIER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), META_TYPE_BARRIER))
#define META_BARRIER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), META_TYPE_BARRIER, MetaBarrierClass))
typedef struct _MetaBarrier MetaBarrier;
typedef struct _MetaBarrierClass MetaBarrierClass;
typedef struct _MetaBarrierPrivate MetaBarrierPrivate;
typedef struct _MetaBarrierEvent MetaBarrierEvent;
struct _MetaBarrier
{
GObject parent;
MetaBarrierPrivate *priv;
};
struct _MetaBarrierClass
{
GObjectClass parent_class;
};
GType meta_barrier_get_type (void) G_GNUC_CONST;
gboolean meta_barrier_is_active (MetaBarrier *barrier);
void meta_barrier_destroy (MetaBarrier *barrier);
void meta_barrier_release (MetaBarrier *barrier,
MetaBarrierEvent *event);
/* Keep in sync with XFixes */
typedef enum {
META_BARRIER_DIRECTION_POSITIVE_X = 1 << 0,
META_BARRIER_DIRECTION_POSITIVE_Y = 1 << 1,
META_BARRIER_DIRECTION_NEGATIVE_X = 1 << 2,
META_BARRIER_DIRECTION_NEGATIVE_Y = 1 << 3,
} MetaBarrierDirection;
/**
* MetaBarrierEvent:
* @event_id: A unique integer ID identifying a
* consecutive series of motions at or along the barrier
* @dt: Server time, in milliseconds, since the last event
* sent for this barrier
* @x: The cursor X position in screen coordinates
* @y: The cursor Y position in screen coordinates.
* @dx: If the cursor hadn't been constrained, the delta
* of X movement past the barrier, in screen coordinates
* @dy: If the cursor hadn't been constrained, the delta
* of X movement past the barrier, in screen coordinates
* @released: A boolean flag, %TRUE if this event generated
* by the pointer leaving the barrier as a result of a client
* calling meta_barrier_release() (will be set only for
* MetaBarrier::leave signals)
* @grabbed: A boolean flag, %TRUE if the pointer was grabbed
* at the time this event was sent
*/
struct _MetaBarrierEvent {
/* < private > */
volatile guint ref_count;
/* < public > */
int event_id;
int dt;
double x;
double y;
double dx;
double dy;
gboolean released;
gboolean grabbed;
};
#define META_TYPE_BARRIER_EVENT (meta_barrier_event_get_type ())
GType meta_barrier_event_get_type (void) G_GNUC_CONST;
G_END_DECLS
#endif /* __META_BARRIER_H__ */