:right-sidebar: True

TouchpadGesturePhase
===================================================================

.. currentmodule:: gi.repository.Gdk





.. class:: TouchpadGesturePhase
   :no-contents-entry:






Specifies the current state of a touchpad gesture.

All gestures are guaranteed to begin with an event with phase
:const:`~gi.repository.Gdk.TouchpadGesturePhase.BEGIN`, followed by 0 or several events
with phase :const:`~gi.repository.Gdk.TouchpadGesturePhase.UPDATE`.

A finished gesture may have 2 possible outcomes, an event with phase
:const:`~gi.repository.Gdk.TouchpadGesturePhase.END` will be emitted when the gesture is
considered successful, this should be used as the hint to perform any
permanent changes.

Cancelled gestures may be so for a variety of reasons, due to hardware
or the compositor, or due to the gesture recognition layers hinting the
gesture did not finish resolutely (eg. a 3rd finger being added during
a pinch gesture). In these cases, the last event will report the phase
:const:`~gi.repository.Gdk.TouchpadGesturePhase.CANCEL`, this should be used as a hint
to undo any visible/permanent changes that were done throughout the
progress of the gesture.












Fields
------

.. rst-class:: interim-class

.. class:: TouchpadGesturePhase
   :no-index:
   

   .. attribute:: BEGIN

      The type of the None singleton.







   .. attribute:: CANCEL

      The type of the None singleton.







   .. attribute:: END

      The type of the None singleton.







   .. attribute:: UPDATE

      The type of the None singleton.