GestureZoom

#GtkGestureZoom is a #GtkGesture implementation able to recognize pinch/zoom gestures, whenever the distance between both tracked sequences changes, the #GtkGestureZoom::scale-changed signal is emitted to report the scale factor.

Constructors

this
this(GtkGestureZoom* gtkGestureZoom, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this(Widget widget)

Returns a newly created #GtkGesture that recognizes zoom in/out gestures (usually known as pinch/zoom).

Members

Functions

addOnScaleChanged
void addOnScaleChanged(void delegate(double, GestureZoom) dlg, ConnectFlags connectFlags)

This signal is emitted whenever the distance between both tracked sequences changes.

getGestureZoomStruct
GtkGestureZoom* getGestureZoomStruct()

Get the main Gtk struct

getScaleDelta
double getScaleDelta()

If @gesture is active, this function returns the zooming difference since the gesture was recognized (hence the starting point is considered 1:1). If @gesture is not active, 1 is returned.

getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackScaleChanged
void callBackScaleChanged(GtkGestureZoom* gesturezoomStruct, double scale, GestureZoom _gesturezoom)
Undocumented in source. Be warned that the author may not have intended to support it.
getType
GType getType()

Variables

connectedSignals
int[string] connectedSignals;
Undocumented in source.
gtkGestureZoom
GtkGestureZoom* gtkGestureZoom;

the main Gtk struct

onScaleChangedListeners
void delegate(double, GestureZoom)[] onScaleChangedListeners;
Undocumented in source.

Inherited Members

From Gesture

gtkGesture
GtkGesture* gtkGesture;

the main Gtk struct

getGestureStruct
GtkGesture* getGestureStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
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 #GdkDevice 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 #GdkEventSequence 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 #GdkEventSequences currently being interpreted by @gesture.

getWindow
Window getWindow()

Returns the user-defined window that receives the events handled by @gesture. See gtk_gesture_set_window() 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 #GtkGesture::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 gtk_gesture_set_sequence_state() 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 gtk_event_controller_get_widget().

ungroup
void ungroup()

Separates @gesture into an isolated group.

connectedSignals
int[string] connectedSignals;
Undocumented in source.
onBeginListeners
void delegate(GdkEventSequence*, Gesture)[] onBeginListeners;
Undocumented in source.
addOnBegin
void 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 #GtkGesture:n-points, and the #GtkGesture::check handler(s) returned #TRUE.

callBackBegin
void callBackBegin(GtkGesture* gestureStruct, GdkEventSequence* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onBeginGenericListeners
void delegate(Event, Gesture)[] onBeginGenericListeners;
Undocumented in source.
addOnBegin
void 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 #GtkGesture:n-points, and the #GtkGesture::check handler(s) returned #TRUE.

callBackBeginGeneric
void callBackBeginGeneric(GtkGesture* gestureStruct, GdkEvent* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onCancelListeners
void delegate(GdkEventSequence*, Gesture)[] onCancelListeners;
Undocumented in source.
addOnCancel
void addOnCancel(void delegate(GdkEventSequence*, Gesture) dlg, ConnectFlags connectFlags)

This signal is emitted whenever a sequence is cancelled. This usually happens on active touches when gtk_event_controller_reset() is called on @gesture (manually, due to grabs...), or the individual @sequence was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()).

callBackCancel
void callBackCancel(GtkGesture* gestureStruct, GdkEventSequence* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onCancelGenericListeners
void delegate(Event, Gesture)[] onCancelGenericListeners;
Undocumented in source.
addOnCancel
void addOnCancel(void delegate(Event, Gesture) dlg, ConnectFlags connectFlags)

This signal is emitted whenever a sequence is cancelled. This usually happens on active touches when gtk_event_controller_reset() is called on @gesture (manually, due to grabs...), or the individual @sequence was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()).

callBackCancelGeneric
void callBackCancelGeneric(GtkGesture* gestureStruct, GdkEvent* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onEndListeners
void delegate(GdkEventSequence*, Gesture)[] onEndListeners;
Undocumented in source.
addOnEnd
void 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 #GtkGesture::check handler returned %FALSE), or the number of touch sequences became higher or lower than #GtkGesture:n-points.

callBackEnd
void callBackEnd(GtkGesture* gestureStruct, GdkEventSequence* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onEndGenericListeners
void delegate(Event, Gesture)[] onEndGenericListeners;
Undocumented in source.
addOnEnd
void 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 #GtkGesture::check handler returned %FALSE), or the number of touch sequences became higher or lower than #GtkGesture:n-points.

callBackEndGeneric
void callBackEndGeneric(GtkGesture* gestureStruct, GdkEvent* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onSequenceStateChangedListeners
void delegate(GdkEventSequence*, GtkEventSequenceState, Gesture)[] onSequenceStateChangedListeners;
Undocumented in source.
addOnSequenceStateChanged
void addOnSequenceStateChanged(void delegate(GdkEventSequence*, GtkEventSequenceState, Gesture) dlg, ConnectFlags connectFlags)

This signal is emitted whenever a sequence state changes. See gtk_gesture_set_sequence_state() to know more about the expectable sequence lifetimes.

callBackSequenceStateChanged
void callBackSequenceStateChanged(GtkGesture* gestureStruct, GdkEventSequence* sequence, GtkEventSequenceState state, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onSequenceStateChangedGenericListeners
void delegate(Event, GtkEventSequenceState, Gesture)[] onSequenceStateChangedGenericListeners;
Undocumented in source.
addOnSequenceStateChanged
void addOnSequenceStateChanged(void delegate(Event, GtkEventSequenceState, Gesture) dlg, ConnectFlags connectFlags)

This signal is emitted whenever a sequence state changes. See gtk_gesture_set_sequence_state() to know more about the expectable sequence lifetimes.

callBackSequenceStateChangedGeneric
void callBackSequenceStateChangedGeneric(GtkGesture* gestureStruct, GdkEvent* sequence, GtkEventSequenceState state, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onUpdateListeners
void delegate(GdkEventSequence*, Gesture)[] onUpdateListeners;
Undocumented in source.
addOnUpdate
void 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.

callBackUpdate
void callBackUpdate(GtkGesture* gestureStruct, GdkEventSequence* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.
onUpdateGenericListeners
void delegate(Event, Gesture)[] onUpdateGenericListeners;
Undocumented in source.
addOnUpdate
void 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.

callBackUpdateGeneric
void callBackUpdateGeneric(GtkGesture* gestureStruct, GdkEvent* sequence, Gesture _gesture)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta