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

.. highlight:: python



.. _wx.lib.agw.zoombar.ZoomBarEvent:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.zoombar.ZoomBarEvent**
==========================================================================================================================================

Event sent from the :class:`ZoomBar` when a button is activated. 



|

|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>ZoomBarEvent</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.zoombar.ZoomBarEvent_inheritance.svg" alt="Inheritance diagram of ZoomBarEvent" 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.zoombar.ZoomBarEvent.html" title="Event sent from the ZoomBar when a button is activated." alt="" coords="5,313,284,341"/> <area shape="rect" id="node2" href="wx.PyCommandEvent.html" title="PyCommandEvent can be used as a base class for implementing" alt="" coords="51,236,238,265"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="61,159,229,188"/> <area shape="rect" id="node4" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="98,82,192,111"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="95,5,194,34"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.PyCommandEvent`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.agw.zoombar.ZoomBarEvent.__init__`                                Default class constructor.
:meth:`~wx.lib.agw.zoombar.ZoomBarEvent.GetLabel`                                Returns the text label of the selected button.
:meth:`~wx.lib.agw.zoombar.ZoomBarEvent.GetSelection`                            Returns the index of the selected button.
:meth:`~wx.lib.agw.zoombar.ZoomBarEvent.SetLabel`                                Sets the text label of the selected button.
:meth:`~wx.lib.agw.zoombar.ZoomBarEvent.SetSelection`                            Sets the index of the selected button.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: ZoomBarEvent(wx.PyCommandEvent)

   Event sent from the :class:`ZoomBar` when a button is activated. 

   .. method:: __init__(self, eventType, eventId=1)

      Default class constructor.
      
      :param `eventType`: the event type;
      :param `eventId`: the event identifier.


   .. method:: GetLabel(self)

      Returns the text label of the selected button. 


   .. method:: GetSelection(self)

      Returns the index of the selected button. 


   .. method:: SetLabel(self, label)

      Sets the text label of the selected button.
      
      :param `label`: the text label of the selected button.


   .. method:: SetSelection(self, selection)

      Sets the index of the selected button.
      
      :param `selection`: an integer indicating the current selected button.