.. 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.shapedbutton
.. highlight:: python
.. _wx.lib.agw.shapedbutton.SButtonEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.shapedbutton.SButtonEvent**
==========================================================================================================================================
Event sent from the generic buttons when the button is activated.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
SButtonEvent:
|
|super_classes| Known Superclasses
==================================
:class:`wx.CommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.shapedbutton.SButtonEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.shapedbutton.SButtonEvent.GetButtonObj` Returns the object associated with this event.
:meth:`~wx.lib.agw.shapedbutton.SButtonEvent.GetIsDown` Returns ``True`` if the button event is "pressed".
:meth:`~wx.lib.agw.shapedbutton.SButtonEvent.SetButtonObj` Sets the event object for the event.
:meth:`~wx.lib.agw.shapedbutton.SButtonEvent.SetIsDown` Sets the button event as pressed.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: SButtonEvent(wx.CommandEvent)
Event sent from the generic buttons when the button is activated.
.. method:: __init__(self, eventType, eventId)
Default class constructor.
:param `eventType`: the event type;
:param `eventId`: the event identifier.
.. method:: GetButtonObj(self)
Returns the object associated with this event.
.. method:: GetIsDown(self)
Returns ``True`` if the button event is "pressed".
.. method:: SetButtonObj(self, btn)
Sets the event object for the event.
:param `btn`: the button object.
.. method:: SetIsDown(self, isDown)
Sets the button event as pressed.
:param `isDown`: ``True`` to set the event as "pressed", ``False`` otherwise.