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

Inheritance diagram for class
ZoomBarEvent:
|
|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.