.. 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

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>RulerCtrlEvent</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.agw.rulerctrl.RulerCtrlEvent_inheritance.svg" alt="Inheritance diagram of RulerCtrlEvent" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.rulerctrl.RulerCtrlEvent.html" title="Represent details of the events that the RulerCtrl object sends." alt="" coords="5,236,274,265"/> <area shape="rect" id="node2" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="56,159,224,188"/> <area shape="rect" id="node3" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="93,82,187,111"/> <area shape="rect" id="node4" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="90,5,189,34"/> </map> 
   </p>
   </div>

|


|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.