.. 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.RotateGestureEvent:
==========================================================================================================================================
|phoenix_title| **wx.RotateGestureEvent**
==========================================================================================================================================
This event is generated when two fingers move in opposite directions on the surface.
.. _RotateGestureEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.RotateGestureEvent` parameter.
- EVT_GESTURE_ROTATE: Process a ``wxEVT_GESTURE_ROTATE`` .
.. versionadded:: 4.1/wxWidgets-3.1.1
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
RotateGestureEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.RotateGestureEvent.__init__` Constructor.
:meth:`~wx.RotateGestureEvent.GetRotationAngle` Returns the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
:meth:`~wx.RotateGestureEvent.SetRotationAngle` Sets the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.RotateGestureEvent.RotationAngle` See :meth:`~wx.RotateGestureEvent.GetRotationAngle` and :meth:`~wx.RotateGestureEvent.SetRotationAngle`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.RotateGestureEvent(GestureEvent)
**Possible constructors**::
RotateGestureEvent(windid: int=0) -> None
This event is generated when two fingers move in opposite directions
on the surface.
.. method:: __init__(self, windid: int=0)
Constructor.
:param `windid`:
:type `windid`: wx.WindowID
:rtype: `None`
.. method:: GetRotationAngle(self)
Returns the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
when :meth:`~wx.GestureEvent.IsGestureStart` returned ``True``. This value is always greater than or equal to zero.
:rtype: `float`
.. method:: SetRotationAngle(self, rotationAngle : float)
Sets the total angle of rotation in radians in clockwise direction since the gesture was first started i.e.
when :meth:`~wx.GestureEvent.IsGestureStart` returned ``True``. This value is always greater than or equal to zero.
:param `rotationAngle`:
:type `rotationAngle`: float
:rtype: `None`
.. attribute:: RotationAngle
See :meth:`~wx.RotateGestureEvent.GetRotationAngle` and :meth:`~wx.RotateGestureEvent.SetRotationAngle`