GestureSingle

gtk.GestureSingle is a subclass of gtk.Gesture, optimized (although not restricted) for dealing with mouse and single-touch gestures. Under interaction, these gestures stick to the first interacting sequence, which is accessible through Gesture.singleGetCurrentSequence while the gesture is being interacted with.

By default gestures react to both GDK_BUTTON_PRIMARY and touch events, Gesture.singleSetTouchOnly can be used to change the touch behavior. Callers may also specify a different mouse button number to interact with through Gesture.singleSetButton, or react to any mouse button by setting 0. While the gesture is active, the button being currently pressed can be known through Gesture.singleGetCurrentButton.

class GestureSingle : Gesture {

protected

GtkGestureSingle* gtkGestureSingle;

GtkGestureSingle* getGestureSingleStruct(bool transferOwnership);

void* getStruct();

this(GtkGestureSingle* gtkGestureSingle, bool ownedRef);

static GType getType();

uint getButton();

uint getCurrentButton();

GdkEventSequence* getCurrentSequence();

bool getExclusive();

bool getTouchOnly();

void setButton(uint button);

void setExclusive(bool exclusive);

void setTouchOnly(bool touchOnly);

}

Constructors

this this(GtkGestureSingle* gtkGestureSingle, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

getButton uint getButton(): Returns the button number gesture listens for, or 0 if gesture reacts to any button press.
getCurrentButton uint getCurrentButton(): Returns the button number currently interacting with gesture, or 0 if there is none.
getCurrentSequence GdkEventSequence* getCurrentSequence(): Returns the event sequence currently interacting with gesture. This is only meaningful if Gesture.isActive returns TRUE.
getExclusive bool getExclusive(): Gets whether a gesture is exclusive. For more information, see Gesture.singleSetExclusive.
getGestureSingleStruct GtkGestureSingle* getGestureSingleStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getTouchOnly bool getTouchOnly(): Returns TRUE if the gesture is only triggered by touch events.
setButton void setButton(uint button): Sets the button number gesture listens to. If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1.
setExclusive void setExclusive(bool exclusive): Sets whether gesture is exclusive. An exclusive gesture will only handle pointer and "pointer emulated" touch events, so at any given time, there is only one sequence able to interact with those.
setTouchOnly void setTouchOnly(bool touchOnly): If touch_only is TRUE, gesture will only handle events of type GDK_TOUCH_BEGIN, GDK_TOUCH_UPDATE or GDK_TOUCH_END If FALSE, mouse events will be handled too.

Static functions

getType GType getType()

Variables

gtkGestureSingle GtkGestureSingle* gtkGestureSingle;: the main Gtk struct

Inherited Members

From Gesture

gtkGesture GtkGesture* gtkGesture;: the main Gtk struct
getGestureStruct GtkGesture* getGestureStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
getBoundingBox bool getBoundingBox(GdkRectangle rect): If there are touch sequences being currently handled by gesture, this function returns TRUE and fills in rect with the bounding box containing all active touches. Otherwise, FALSE will be returned.
getBoundingBoxCenter bool getBoundingBoxCenter(double x, double y): If there are touch sequences being currently handled by gesture, this function returns TRUE and fills in x and y with the center of the bounding box containing all active touches. Otherwise, FALSE will be returned.
getDevice Device getDevice(): Returns the master gdk.Device that is currently operating on gesture, or NULL if the gesture is not being interacted.
getGroup ListG getGroup(): Returns all gestures in the group of gesture
getLastEvent Event getLastEvent(GdkEventSequence* sequence): Returns the last event that was processed for sequence.
getLastUpdatedSequence GdkEventSequence* getLastUpdatedSequence(): Returns the gdk.EventSequence that was last updated on gesture.
getPoint bool getPoint(GdkEventSequence* sequence, double x, double y): If sequence is currently being interpreted by gesture, this function returns TRUE and fills in x and y with the last coordinates stored for that event sequence. The coordinates are always relative to the widget allocation.
getSequenceState GtkEventSequenceState getSequenceState(GdkEventSequence* sequence): Returns the sequence state, as seen by gesture.
getSequences ListG getSequences(): Returns the list of gdk.EventSequences currently being interpreted by gesture.
getWindow Window getWindow(): Returns the user-defined window that receives the events handled by gesture. See Gesture.setWindow for more information.
group void group(Gesture gesture): Adds gesture to the same group than group_gesture. Gestures are by default isolated in their own groups.
handlesSequence bool handlesSequence(GdkEventSequence* sequence): Returns TRUE if gesture is currently handling events corresponding to sequence.
isActive bool isActive(): Returns TRUE if the gesture is currently active. A gesture is active meanwhile there are touch sequences interacting with it.
isGroupedWith bool isGroupedWith(Gesture other): Returns TRUE if both gestures pertain to the same group.
isRecognized bool isRecognized(): Returns TRUE if the gesture is currently recognized. A gesture is recognized if there are as many interacting touch sequences as required by gesture, and check returned TRUE for the sequences being currently interpreted.
setSequenceState bool setSequenceState(GdkEventSequence* sequence, GtkEventSequenceState state): Sets the state of sequence in gesture. Sequences start in state GTK_EVENT_SEQUENCE_NONE, and whenever they change state, they can never go back to that state. Likewise, sequences in state GTK_EVENT_SEQUENCE_DENIED cannot turn back to a not denied state. With these rules, the lifetime of an event sequence is constrained to the next four:
setState bool setState(GtkEventSequenceState state): Sets the state of all sequences that gesture is currently interacting with. See Gesture.setSequenceState for more details on sequence states.
setWindow void setWindow(Window window): Sets a specific window to receive events about, so gesture will effectively handle only events targeting window, or a child of it. window must pertain to Event.controllerGetWidget.
ungroup void ungroup(): Separates gesture into an isolated group.
addOnBegin gulong addOnBegin(void delegate(GdkEventSequence*, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted when the gesture is recognized. This means the number of touch sequences matches n-points, and the check handler(s) returned TRUE
addOnBegin gulong addOnBegin(void delegate(Event, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted when the gesture is recognized. This means the number of touch sequences matches n-points, and the check handler(s) returned TRUE
addOnCancel gulong addOnCancel(void delegate(GdkEventSequence*, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted whenever a sequence is cancelled. This usually happens on active touches when Event.controllerReset is called on gesture (manually, due to grabs...), or the individual sequence was claimed by parent widgets' controllers (see Gesture.setSequenceState).
addOnCancel gulong addOnCancel(void delegate(Event, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted whenever a sequence is cancelled. This usually happens on active touches when Event.controllerReset is called on gesture (manually, due to grabs...), or the individual sequence was claimed by parent widgets' controllers (see Gesture.setSequenceState).
addOnEnd gulong addOnEnd(void delegate(GdkEventSequence*, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted when gesture either stopped recognizing the event sequences as something to be handled (the check handler returned FALSE), or the number of touch sequences became higher or lower than n-points.
addOnEnd gulong addOnEnd(void delegate(Event, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted when gesture either stopped recognizing the event sequences as something to be handled (the check handler returned FALSE), or the number of touch sequences became higher or lower than n-points.
addOnSequenceStateChanged gulong addOnSequenceStateChanged(void delegate(GdkEventSequence*, GtkEventSequenceState, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted whenever a sequence state changes. See Gesture.setSequenceState to know more about the expectable sequence lifetimes.
addOnSequenceStateChanged gulong addOnSequenceStateChanged(void delegate(Event, GtkEventSequenceState, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted whenever a sequence state changes. See Gesture.setSequenceState to know more about the expectable sequence lifetimes.
addOnUpdate gulong addOnUpdate(void delegate(GdkEventSequence*, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted whenever an event is handled while the gesture is recognized. sequence is guaranteed to pertain to the set of active touches.
addOnUpdate gulong addOnUpdate(void delegate(Event, Gesture) dlg, ConnectFlags connectFlags): This signal is emitted whenever an event is handled while the gesture is recognized. sequence is guaranteed to pertain to the set of active touches.

gtk GestureSingle classes

GestureSingle