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

Inheritance diagram for class
RulerCtrlEvent:
|
|super_classes| Known Superclasses
==================================
:class:`wx.CommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.rulerctrl.RulerCtrlEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.rulerctrl.RulerCtrlEvent.GetOldValue` Returns the event old value.
:meth:`~wx.lib.agw.rulerctrl.RulerCtrlEvent.GetValue` Returns the event value.
:meth:`~wx.lib.agw.rulerctrl.RulerCtrlEvent.SetOldValue` Sets the event old value.
:meth:`~wx.lib.agw.rulerctrl.RulerCtrlEvent.SetValue` Sets the event value.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: RulerCtrlEvent(wx.CommandEvent)
Represent details of the events that the :class:`RulerCtrl` object sends.
.. method:: __init__(self, eventType, eventId=1)
Default class constructor.
:param `eventType`: the event type;
:param `eventId`: the event identifier.
.. method:: GetOldValue(self)
Returns the event old value.
.. method:: GetValue(self)
Returns the event value.
.. method:: SetOldValue(self, oldValue)
Sets the event old value.
:param `value`: the old indicator position.
.. method:: SetValue(self, value)
Sets the event value.
:param `value`: the new indicator position.