.. 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
.. currentmodule:: wx.lib.agw.knobctrl
.. highlight:: python
.. _wx.lib.agw.knobctrl.KnobCtrlEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.knobctrl.KnobCtrlEvent**
==========================================================================================================================================
Represent details of the events that the :class:`KnobCtrl` object sends.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
KnobCtrlEvent:
|
|super_classes| Known Superclasses
==================================
:class:`wx.CommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.knobctrl.KnobCtrlEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.knobctrl.KnobCtrlEvent.GetOldValue` Returns the old :class:`KnobCtrl` value for this event.
:meth:`~wx.lib.agw.knobctrl.KnobCtrlEvent.GetValue` Returns the new :class:`KnobCtrl` value for this event.
:meth:`~wx.lib.agw.knobctrl.KnobCtrlEvent.SetOldValue` Sets the old :class:`KnobCtrl` value for this event.
:meth:`~wx.lib.agw.knobctrl.KnobCtrlEvent.SetValue` Sets the new :class:`KnobCtrl` value for this event.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: KnobCtrlEvent(wx.CommandEvent)
Represent details of the events that the :class:`KnobCtrl` object sends.
.. method:: __init__(self, eventType, eventId=1)
Default class constructor.
For internal use: do not call it in your code!
:param `eventType`: the event type;
:param `eventId`: the event identifier.
.. method:: GetOldValue(self)
Returns the old :class:`KnobCtrl` value for this event.
.. method:: GetValue(self)
Returns the new :class:`KnobCtrl` value for this event.
.. method:: SetOldValue(self, oldValue)
Sets the old :class:`KnobCtrl` value for this event.
:param `oldValue`: an integer representing the old value.
.. method:: SetValue(self, value)
Sets the new :class:`KnobCtrl` value for this event.
:param `value`: an integer representing the new value.