.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.PanGestureEvent:
==========================================================================================================================================
|phoenix_title| **wx.PanGestureEvent**
==========================================================================================================================================
This event is generated when the user moves a finger on the surface.
wxGTK also generates this event during mouse dragging (mouse motion while a left mouse button is depressed).
Note that OSX requires the primary mouse button to be pressed while performing the finger movement.
.. _PanGestureEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.PanGestureEvent` parameter.
- EVT_GESTURE_PAN: Process a ``wxEVT_GESTURE_PAN`` .
.. versionadded:: 4.1/wxWidgets-3.1.1
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
PanGestureEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PanGestureEvent.__init__` Constructor.
:meth:`~wx.PanGestureEvent.GetDelta` Returns the distance covered since the previous panning event.
:meth:`~wx.PanGestureEvent.SetDelta` Sets the distance covered since the previous panning event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.PanGestureEvent.Delta` See :meth:`~wx.PanGestureEvent.GetDelta` and :meth:`~wx.PanGestureEvent.SetDelta`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PanGestureEvent(GestureEvent)
**Possible constructors**::
PanGestureEvent(winid: int=0) -> None
This event is generated when the user moves a finger on the surface.
.. method:: __init__(self, winid: int=0)
Constructor.
:param `winid`:
:type `winid`: wx.WindowID
:rtype: `None`
.. method:: GetDelta(self)
Returns the distance covered since the previous panning event.
:rtype: :ref:`wx.Point`
.. method:: SetDelta(self, delta : Point)
Sets the distance covered since the previous panning event.
:param `delta`:
:type `delta`: wx.Point
:rtype: `None`
.. attribute:: Delta
See :meth:`~wx.PanGestureEvent.GetDelta` and :meth:`~wx.PanGestureEvent.SetDelta`